Comments, reworking inheritance of method

Author: snbianco

CHANGES.rst

@@ -5,8 +5,20 @@ Unreleased
   the specified coordinates. [#166]
 - Added ``write_as_zip`` method to ``ASDFCutout``, ``FITSCutout``, ``TessCubeCutout``, and ``TessFootprintCutout`` classes to facilitate 
   writing multiple cutouts into a single ZIP archive. [#167]
-- Updated the format of cube cutout filenames to include a hyphen between the dimensions (e.g., ``10-x-10`` instead of ``10x10``)
-  for improved readability and consistency with other classes. [#168]
+
+Breaking Changes
+^^^^^^^^^^^^^^^^
+
+- Cube cutout filenames now use a hyphen between dimensions (e.g., ``10-x-10`` instead of ``10x10``). They also include unit suffixes when 
+  users request sizes as an `astropy.units.Quantity` object (e.g., ``5arcmin-x-4arcmin`` or ``30arcsec-x-20arcsec``). This change may break 
+  code that parses filenames or relies on old glob patterns. [#167]
+
+  Migration:
+
+  - Update glob patterns from ``*_<ra>_<dec>_<ny>x<nx>_astrocut.fits`` to ``*_<ra>_<dec>_*-x-*_astrocut.fits``.
+  - If parsing filenames, adjust regex accordingly (e.g., replace ``(?P<ny>\d+)x(?P<nx>\d+)`` with 
+    ``(?P<ny>\d+(?:\.\d+)?)(?P<ny_unit>arcsec|arcmin|deg|pixel|pix)?-x-(?P<nx>\d+(?:\.\d+)?)(?P<nx_unit>arcsec|arcmin|deg|pixel|pix)?``).
+  - Prefer reading dimensions from file metadata (e.g., FITS headers) when possible to avoid filename coupling.
 
 
 1.1.0 (2025-09-15)

astrocut/asdf_cutout.py

@@ -518,7 +518,7 @@ def write_as_asdf(self, output_dir: Union[str, Path] = '.') -> List[str]:
         return self._write_as_format(output_format='.asdf', output_dir=output_dir)
 
     def write_as_zip(self, output_dir: Union[str, Path] = '.', filename: Union[str, Path, None] = None,
-                     *, format: str = '.asdf') -> str:
+                     *, output_format: str = '.asdf') -> str:
         """
         Package the ASDF or FITS cutouts into a zip archive without writing intermediates.
 
@@ -530,15 +530,15 @@ def write_as_zip(self, output_dir: Union[str, Path] = '.', filename: Union[str,
             Name (or path) of the output zip file. If not provided, defaults to
             'cutouts_{YYYYmmdd_HHMMSS}.zip'. If provided without a '.zip' suffix,
             the suffix is added automatically.
-        format : str, optional
+        output_format : str, optional
             Either '.asdf' (default) or '.fits'. Determines which in-memory representation is zipped.
 
         Returns
         -------
         str
             Path to the created zip file.
         """
-        fmt = format.lower().strip()
+        fmt = output_format.lower().strip()
         fmt = '.' + fmt if not fmt.startswith('.') else fmt
         if fmt not in ('.asdf', '.fits'):
             raise InvalidInputError("File format must be either '.asdf' or '.fits'")
@@ -551,7 +551,7 @@ def build_entries():
                 arcname = self._make_cutout_filename(file, fmt)
                 yield arcname, objs[i]
 
-        return super().write_as_zip(output_dir=output_dir, filename=filename, build_entries=build_entries)
+        return self._write_cutouts_to_zip(output_dir=output_dir, filename=filename, build_entries=build_entries)
 
 
 def get_center_pixel(gwcsobj: gwcs.wcs.WCS, ra: float, dec: float) -> Tuple[Tuple[int, int], WCS]:

astrocut/cutout.py

@@ -193,10 +193,7 @@ def _obj_to_bytes(self, obj: Union[fits.HDUList, asdf.AsdfFile]) -> bytes:
             buf = io.BytesIO()
             with warnings.catch_warnings():
                 warnings.simplefilter('ignore', fits.verify.VerifyWarning)
-                try:
-                    obj.writeto(buf, overwrite=True, checksum=True)
-                except TypeError:
-                    obj.writeto(buf)
+                obj.writeto(buf, overwrite=True, checksum=True)
         # `AsdfFile` to bytes
         elif isinstance(obj, asdf.AsdfFile):
             buf = io.BytesIO()
@@ -208,11 +205,11 @@ def _obj_to_bytes(self, obj: Union[fits.HDUList, asdf.AsdfFile]) -> bytes:
 
         return buf.getvalue()
 
-    def write_as_zip(
+    def _write_cutouts_to_zip(
         self,
         output_dir: Union[str, Path] = ".",
         filename: Optional[Union[str, Path]] = None,
-        build_entries: Optional[Callable[[], Iterable[Tuple[str, Any]]]] = None,
+        build_entries: Optional[Callable[[], Iterable[Tuple[str, Any]]]] = None
     ) -> str:
         """
         Create a zip archive containing all cutout files without writing intermediate files.

astrocut/fits_cutout.py

@@ -461,7 +461,7 @@ def build_entries():
                     hdu = self.fits_cutouts[i]
                     yield arcname, hdu
 
-        return super().write_as_zip(output_dir=output_dir, filename=filename, build_entries=build_entries)
+        return self._write_cutouts_to_zip(output_dir=output_dir, filename=filename, build_entries=build_entries)
 
     class CutoutInstance:
         """

astrocut/tess_cube_cutout.py

@@ -530,10 +530,10 @@ def write_as_zip(self, output_dir: Union[str, Path] = '.', filename: Union[str,
         """
         def build_entries():
             for file, tpf in self.tpf_cutouts_by_file.items():
-                arcname = self._make_cutout_filename(file)
+                arcname = self._make_cutout_filename(Path(file).stem.rstrip('-cube'))
                 yield arcname, tpf
 
-        return super().write_as_zip(output_dir=output_dir, filename=filename, build_entries=build_entries)
+        return self._write_cutouts_to_zip(output_dir=output_dir, filename=filename, build_entries=build_entries)
 
     class CubeCutoutInstance(CubeCutout.CubeCutoutInstance):
         """

astrocut/tess_footprint_cutout.py

@@ -253,11 +253,6 @@ def write_as_zip(self, output_dir: Union[str, Path] = '.', filename: Union[str,
         -------
         zip_path : str
             Path to the created zip file.
-
-        Notes
-        -----
-        This method will call `write_as_tpf` to ensure the cutout files exist on disk,
-        then archive those files into a single zip.
         """
         return self.tess_cube_cutout.write_as_zip(output_dir, filename)
 

astrocut/tests/test_asdf_cutout.py

@@ -196,7 +196,7 @@ def test_asdf_cutout_write_to_file(test_images, center_coord, cutout_size, tmpdi
 def test_asdf_cutout_write_to_zip(tmpdir, test_images, center_coord, cutout_size, output_format):
     # Zip ASDF representations
     cutout = ASDFCutout(test_images, center_coord, cutout_size)
-    zip_path = cutout.write_as_zip(output_dir=tmpdir, format=output_format)
+    zip_path = cutout.write_as_zip(output_dir=tmpdir, output_format=output_format)
     assert Path(zip_path).exists()
 
     with zipfile.ZipFile(zip_path, 'r') as zf:
@@ -223,7 +223,7 @@ def test_asdf_cutout_write_to_zip_invalid_format(tmpdir, test_images, center_coo
     # Invalid output format for zip
     cutout = ASDFCutout(test_images, center_coord, cutout_size)
     with pytest.raises(InvalidInputError, match="File format must be either '.asdf' or '.fits'"):
-        cutout.write_as_zip(output_dir=tmpdir, format='.invalid')
+        cutout.write_as_zip(output_dir=tmpdir, output_format='.invalid')
 
 
 def test_asdf_cutout_lite(test_images, center_coord, cutout_size, tmpdir):