pyisyntax 0.1.2__tar.gz → 0.1.3__tar.gz

pyisyntax-0.1.3/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.3] - 2024-03-28
+
+### Added
+
+- This CHANGELOG file.
+
+### Fixed
+
+- Gracefully exit the contextmanager when an ISyntax file fails to open
+  ([#8](https://github.com/anibali/pyisyntax/issues/8)).
+- Release reference to the associated cache object when an ISyntax object is closed
+  so that it can be garbage collected and destroyed
+  ([#9](https://github.com/anibali/pyisyntax/issues/9)).
+
+## [0.1.2] - 2024-03-25
+
+### Added
+
+- Configuration option to set the cache size
+  ([#5](https://github.com/anibali/pyisyntax/issues/5)).
+
+### Changed
+
+- Nest the `_pyisyntax` binary library file under the `isyntax` top-level
+  namespace.
+- Bump the `libisyntax` submodule commit and match their API changes
+  (thanks @erikogabrielsson).
+
+## [0.1.1] - 2024-03-02
+
+### Changed
+
+- Return `None` when an associated image/colour profile is not present.
+- Reduce the number of provided wheels by using `py_limited_api`.
+  Multiple Python versions will continue being tested during CI through
+  the use of `tox`.
+
+## [0.1.0] - 2024-02-26
+
+### Added
+
+- This is the initial release.
+
+[unreleased]: https://github.com/anibali/pyisyntax/compare/v0.1.3...HEAD
+[0.1.3]: https://github.com/anibali/pyisyntax/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/anibali/pyisyntax/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/anibali/pyisyntax/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/anibali/pyisyntax/releases/tag/v0.1.0

{pyisyntax-0.1.2 → pyisyntax-0.1.3}/MANIFEST.in

@@ -1,5 +1,6 @@
 include README.md
 include LICENSE
+include CHANGELOG.md
 
 graft isyntax_build
 prune isyntax_build/vendor/libisyntax

{pyisyntax-0.1.2/pyisyntax.egg-info → pyisyntax-0.1.3}/PKG-INFO

@@ -1,9 +1,14 @@
 Metadata-Version: 2.1
 Name: pyisyntax
-Version: 0.1.2
+Version: 0.1.3
 Summary: Python bindings for libisyntax
 Author-email: Aiden Nibali <dismaldenizen@gmail.com>
 License: MIT
+Project-URL: homepage, https://github.com/anibali/pyisyntax
+Project-URL: source, https://github.com/anibali/pyisyntax
+Project-URL: download, https://pypi.org/project/pyisyntax/#files
+Project-URL: tracker, https://github.com/anibali/pyisyntax/issues
+Project-URL: release notes, https://github.com/anibali/pyisyntax/blob/master/CHANGELOG.md
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE

{pyisyntax-0.1.2 → pyisyntax-0.1.3}/isyntax/wrapper.py

@@ -79,6 +79,9 @@ class ISyntaxImage:
 
 class ISyntax:
     def __init__(self, f: RawIOBase | BufferedIOBase, n_bytes: int, cache_size: int = 2000) -> None:
+        # Start in the "closed" for a graceful contextmanager exit when the file
+        # fails to open.
+        self.closed = True
         self.io_handle = register_io(f, n_bytes)
         self.ptr = libisyntax.open_from_registered_handle(self.io_handle, is_init_allocators=False)
         self.closed = False
@@ -96,6 +99,7 @@ class ISyntax:
         if self.closed:
             return
         libisyntax.close(self.ptr)
+        self._cache = None
         self.closed = True
 
     @property

{pyisyntax-0.1.2 → pyisyntax-0.1.3/pyisyntax.egg-info}/PKG-INFO

@@ -1,9 +1,14 @@
 Metadata-Version: 2.1
 Name: pyisyntax
-Version: 0.1.2
+Version: 0.1.3
 Summary: Python bindings for libisyntax
 Author-email: Aiden Nibali <dismaldenizen@gmail.com>
 License: MIT
+Project-URL: homepage, https://github.com/anibali/pyisyntax
+Project-URL: source, https://github.com/anibali/pyisyntax
+Project-URL: download, https://pypi.org/project/pyisyntax/#files
+Project-URL: tracker, https://github.com/anibali/pyisyntax/issues
+Project-URL: release notes, https://github.com/anibali/pyisyntax/blob/master/CHANGELOG.md
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE

{pyisyntax-0.1.2 → pyisyntax-0.1.3}/pyisyntax.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+CHANGELOG.md
 LICENSE
 MANIFEST.in
 README.md

{pyisyntax-0.1.2 → pyisyntax-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyisyntax"
-version = "0.1.2"
+version = "0.1.3"
 description = "Python bindings for libisyntax"
 readme = { content-type = "text/markdown", file = "README.md" }
 authors = [{ name = "Aiden Nibali", email = "dismaldenizen@gmail.com" }]
@@ -11,6 +11,13 @@ dependencies = [
   "numpy",
 ]
 
+[project.urls]
+homepage = "https://github.com/anibali/pyisyntax"
+source = "https://github.com/anibali/pyisyntax"
+download = "https://pypi.org/project/pyisyntax/#files"
+tracker = "https://github.com/anibali/pyisyntax/issues"
+"release notes" = "https://github.com/anibali/pyisyntax/blob/master/CHANGELOG.md"
+
 [project.optional-dependencies]
 dev = [
   "conda-lock",
@@ -62,6 +69,9 @@ pydocstyle.convention = "google"
 [tool.pyright]
 typeCheckingMode = "standard"
 
+[tool.pytest.ini_options]
+addopts = "-Werror"
+
 [tool.tox]
 legacy_tox_ini = """
 [tox]

{pyisyntax-0.1.2 → pyisyntax-0.1.3}/tests/test_wrapper.py

@@ -1,3 +1,5 @@
+import gc
+import io
 from collections.abc import Iterator
 from pathlib import Path
 
@@ -85,6 +87,7 @@ class TestISyntax:
     def test_read_label_image_jpeg(self, isyntax: ISyntax, mocker: MockerFixture) -> None:
         free_spy = mocker.spy(libisyntax, "free")
         jpeg_data = isyntax.read_label_image_jpeg()
+        assert jpeg_data is not None
         jpeg_magic = b"\xff\xd8"
         assert jpeg_data[:2] == jpeg_magic
         expected_size = 60348
@@ -98,6 +101,7 @@ class TestISyntax:
     def test_read_macro_image_jpeg(self, isyntax: ISyntax, mocker: MockerFixture) -> None:
         free_spy = mocker.spy(libisyntax, "free")
         jpeg_data = isyntax.read_macro_image_jpeg()
+        assert jpeg_data is not None
         jpeg_magic = b"\xff\xd8"
         assert jpeg_data[:2] == jpeg_magic
         expected_size = 49625
@@ -107,3 +111,22 @@ class TestISyntax:
         free_spy.assert_not_called()
         del jpeg_data
         free_spy.assert_called_once()
+
+    def test_close_is_idempotent(self, isyntax: ISyntax) -> None:
+        isyntax.close()
+        isyntax.close()
+        assert isyntax.closed
+
+    def test_cache_is_destroyed_on_close(self, isyntax: ISyntax, mocker: MockerFixture) -> None:
+        destroy_spy = mocker.spy(libisyntax, "cache_destroy")
+        # Reading image data causes the cache to be created.
+        isyntax.read_region(500, 500, 1, 1, level=4)
+        destroy_spy.assert_not_called()
+        isyntax.close()
+        gc.collect()
+        destroy_spy.assert_called_once()
+
+    def test_closes_after_error_from_contextmanager(self) -> None:
+        f = io.BytesIO()
+        with pytest.raises(libisyntax.LibISyntaxFatalError), ISyntax(f, 0):
+            pass