Pillow/Tests/test_file_hdf5stub.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

85 lines
2.0 KiB
Python
Raw Normal View History

from __future__ import annotations
2024-01-20 14:23:03 +03:00
from pathlib import Path
2024-02-12 13:06:17 +03:00
from typing import IO
2020-01-27 14:46:52 +03:00
import pytest
from PIL import Hdf5StubImagePlugin, Image
TEST_FILE = "Tests/images/hdf5.h5"
2015-07-03 08:03:25 +03:00
def test_open() -> None:
2020-01-27 14:46:52 +03:00
# Act
with Image.open(TEST_FILE) as im:
# Assert
assert im.format == "HDF5"
# Dummy data from the stub
assert im.mode == "F"
assert im.size == (1, 1)
def test_invalid_file() -> None:
2020-01-27 14:46:52 +03:00
# Arrange
invalid_file = "Tests/images/flower.jpg"
2020-01-27 14:46:52 +03:00
# Act / Assert
with pytest.raises(SyntaxError):
Hdf5StubImagePlugin.HDF5StubImageFile(invalid_file)
2015-07-03 09:22:56 +03:00
def test_load() -> None:
2020-01-27 14:46:52 +03:00
# Arrange
with Image.open(TEST_FILE) as im:
# Act / Assert: stub cannot load without an implemented handler
with pytest.raises(OSError):
2020-01-27 14:46:52 +03:00
im.load()
def test_save() -> None:
2020-01-27 14:46:52 +03:00
# Arrange
with Image.open(TEST_FILE) as im:
dummy_fp = None
dummy_filename = "dummy.filename"
Improve handling of file resources Follow Python's file object semantics. User code is responsible for closing resources (usually through a context manager) in a deterministic way. To achieve this, remove __del__ functions. These functions used to closed open file handlers in an attempt to silence Python ResourceWarnings. However, using __del__ has the following drawbacks: - __del__ isn't called until the object's reference count reaches 0. Therefore, resource handlers remain open or in use longer than necessary. - The __del__ method isn't guaranteed to execute on system exit. See the Python documentation: https://docs.python.org/3/reference/datamodel.html#object.__del__ > It is not guaranteed that __del__() methods are called for objects > that still exist when the interpreter exits. - Exceptions that occur inside __del__ are ignored instead of raised. This has the potential of hiding bugs. This is also in the Python documentation: > Warning: Due to the precarious circumstances under which __del__() > methods are invoked, exceptions that occur during their execution > are ignored, and a warning is printed to sys.stderr instead. Instead, always close resource handlers when they are no longer in use. This will close the file handler at a specified point in the user's code and not wait until the interpreter chooses to. It is always guaranteed to run. And, if an exception occurs while closing the file handler, the bug will not be ignored. Now, when code receives a ResourceWarning, it will highlight an area that is mishandling resources. It should not simply be silenced, but fixed by closing resources with a context manager. All warnings that were emitted during tests have been cleaned up. To enable warnings, I passed the `-Wa` CLI option to Python. This exposed some mishandling of resources in ImageFile.__init__() and SpiderImagePlugin.loadImageSeries(), they too were fixed.
2019-05-25 19:30:58 +03:00
2020-01-27 14:46:52 +03:00
# Act / Assert: stub cannot save without an implemented handler
with pytest.raises(OSError):
2020-01-27 14:46:52 +03:00
im.save(dummy_filename)
with pytest.raises(OSError):
2020-01-27 14:46:52 +03:00
Hdf5StubImagePlugin._save(im, dummy_fp, dummy_filename)
2022-02-19 06:29:03 +03:00
def test_handler(tmp_path: Path) -> None:
2022-02-19 06:29:03 +03:00
class TestHandler:
opened = False
loaded = False
saved = False
2024-02-12 13:06:17 +03:00
def open(self, im: Image.Image) -> None:
2022-02-19 06:29:03 +03:00
self.opened = True
2024-02-12 13:06:17 +03:00
def load(self, im: Image.Image) -> Image.Image:
2022-02-19 06:29:03 +03:00
self.loaded = True
2023-03-11 14:39:11 +03:00
im.fp.close()
2022-02-19 06:29:03 +03:00
return Image.new("RGB", (1, 1))
2024-02-12 13:06:17 +03:00
def save(self, im: Image.Image, fp: IO[bytes], filename: str) -> None:
2022-02-19 06:29:03 +03:00
self.saved = True
handler = TestHandler()
Hdf5StubImagePlugin.register_handler(handler)
with Image.open(TEST_FILE) as im:
assert handler.opened
assert not handler.loaded
im.load()
assert handler.loaded
temp_file = str(tmp_path / "temp.h5")
im.save(temp_file)
assert handler.saved
Hdf5StubImagePlugin._handler = None