astro-metadata-translator 29.2025.4200__py3-none-any.whl → 29.2025.4400__py3-none-any.whl

astro_metadata_translator/bin/translate.py

@@ -23,18 +23,22 @@ import math
 import traceback
 from collections import defaultdict
 from collections.abc import Sequence
-from typing import IO, Any
+from typing import IO, TYPE_CHECKING, Any
 
 import astropy.time
 import astropy.units as u
 import yaml
 from astropy.table import Column, MaskedColumn, QTable
+from lsst.resources import ResourcePath
 
 from astro_metadata_translator import MetadataTranslator, ObservationInfo, fix_header
 
 from ..file_helpers import find_files, read_basic_metadata_from_file
 from ..properties import PROPERTIES
 
+if TYPE_CHECKING:
+    from lsst.resources import ResourcePathExpression
+
 log = logging.getLogger(__name__)
 
 # Output mode choices
@@ -74,7 +78,7 @@ TABLE_COLUMNS = (
 
 
 def read_file(
-    file: str,
+    file: ResourcePathExpression,
     hdrnum: int,
     print_trace: bool,
     output_columns: defaultdict[str, list],
@@ -86,7 +90,7 @@ def read_file(
 
     Parameters
     ----------
-    file : `str`
+    file : `str` or `lsst.resources.ResourcePathExpression`
         The file from which the header is to be read.
     hdrnum : `int`
         The HDU number to read. The primary header is always read and
@@ -127,10 +131,11 @@ def read_file(
     if output_mode != "table":
         log.info("Analyzing %s...", file)
 
+    uri = ResourcePath(file, forceDirectory=False)
     try:
-        md = read_basic_metadata_from_file(file, hdrnum, can_raise=True)
+        md = read_basic_metadata_from_file(uri, hdrnum, can_raise=True)
         if md is None:
-            raise RuntimeError(f"Failed to read file {file} HDU={hdrnum}")
+            raise RuntimeError(f"Failed to read file {uri} HDU={hdrnum}")
 
         if output_mode.endswith("native"):
             # Strip native and don't change type of md
@@ -141,21 +146,21 @@ def read_file(
 
         if output_mode in ("yaml", "fixed"):
             if output_mode == "fixed":
-                fix_header(md, filename=file)
+                fix_header(md, filename=str(uri))
 
             # The header should be written out in the insertion order
             print(yaml.dump(md, sort_keys=False), file=outstream)
             return True
 
         # Try to work out a translator class.
-        translator_class = MetadataTranslator.determine_translator(md, filename=file)
+        translator_class = MetadataTranslator.determine_translator(md, filename=str(uri))
 
         # Work out which headers to translate, assuming the default if
         # we have a YAML test file.
-        if file.endswith(".yaml"):
+        if uri.getExtension() == ".yaml":
             headers = [md]
         else:
-            headers = list(translator_class.determine_translatable_headers(file, md))
+            headers = list(translator_class.determine_translatable_headers(uri, md))
         if output_mode == "auto":
             output_mode = "table" if len(headers) > 1 else "verbose"
 
@@ -163,7 +168,7 @@ def read_file(
             raise ValueError("Table mode requires output columns")
 
         for md in headers:
-            obs_info = ObservationInfo(md, pedantic=False, filename=file)
+            obs_info = ObservationInfo(md, pedantic=False, filename=str(uri))
             if output_mode == "table":
                 for c in TABLE_COLUMNS:
                     output_columns[c["label"]].append(getattr(obs_info, c["attr"]))
@@ -178,7 +183,7 @@ def read_file(
         if print_trace:
             traceback.print_exc(file=outstream)
         else:
-            print(f"Failure processing {file}: {e}", file=outstream)
+            print(f"Failure processing {uri}: {e}", file=outstream)
         return False
     return True
 
@@ -308,9 +313,9 @@ def translate_or_dump_headers(
         isok = read_file(path, hdrnum, print_trace, output_columns, outstream, output_mode, heading)
         heading = False
         if isok:
-            okay.append(path)
+            okay.append(str(path))
         else:
-            failed.append(path)
+            failed.append(str(path))
 
         # Check if we have exceeded the page size and should dump the table.
         if output_mode == "table" and len(output_columns[TABLE_COLUMNS[0]["label"]]) >= MAX_TABLE_PAGE_SIZE:

astro_metadata_translator/bin/writeindex.py

@@ -19,6 +19,8 @@ import os
 from collections.abc import MutableMapping, Sequence
 from typing import IO
 
+from lsst.resources import ResourcePath
+
 from ..file_helpers import find_files
 from ..indexing import index_files
 
@@ -87,15 +89,19 @@ def write_index_files(
 
     failed = []
     okay = []
-    files_per_directory: MutableMapping[str, list[str]] = {}
+    files_per_directory: MutableMapping[ResourcePath, list[ResourcePath]] = {}
 
     # Group each file by directory if no explicit output path
     if outpath is None:
         for path in found_files:
-            head, tail = os.path.split(path)
-            files_per_directory.setdefault(head, []).append(tail)
+            head, tail = path.split()
+            files_per_directory.setdefault(head, []).append(ResourcePath(tail, forceAbsolute=False))
     else:
-        files_per_directory["."] = list(found_files)
+        # We want the requested files to be paths relative to the current
+        # directory. For now this assumes that all the input files are
+        # local -- we are not trying to discover a shared root directory.
+        cwd = ResourcePath(".", forceAbsolute=True, forceDirectory=True)
+        files_per_directory[cwd] = list(found_files)
 
     # Extract translated metadata for each file in each directory
     for directory, files_in_dir in files_per_directory.items():
@@ -113,11 +119,10 @@ def write_index_files(
 
         # Write the index file
         if outpath is None:
-            index_file = os.path.join(directory, "_index.json")
+            index_file = directory.join("_index.json")
         else:
-            index_file = outpath
-        with open(index_file, "w") as fd:
-            print(json.dumps(output), file=fd)
-            log.info("Wrote index file to %s", index_file)
+            index_file = ResourcePath(outpath, forceAbsolute=False)
+        index_file.write(json.dumps(output).encode())
+        log.info("Wrote index file to %s", index_file)
 
     return okay, failed

astro_metadata_translator/bin/writesidecar.py

@@ -14,45 +14,22 @@ from __future__ import annotations
 __all__ = ("write_sidecar_file", "write_sidecar_files")
 
 import logging
-import os
 import traceback
 from collections.abc import Sequence
-from typing import IO
+from typing import IO, TYPE_CHECKING
 
-from ..file_helpers import find_files, read_file_info
-
-log = logging.getLogger(__name__)
-
-
-def _split_ext(file: str) -> tuple[str, str]:
-    """Split the extension from the file name and return it and the root.
-
-    Parameters
-    ----------
-    file : `str`
-        The file name to examine.
+from lsst.resources import ResourcePath
 
-    Returns
-    -------
-    root : `str`
-        The root of the file name.
-    ext : `str`
-        The file extension. There is special case handling of .gz and other
-        compression extensions.
-    """
-    special = {".gz", ".bz2", ".xz", ".fz"}
-
-    root, ext = os.path.splitext(file)
+from ..file_helpers import find_files, read_file_info
 
-    if ext in special:
-        root, second_ext = os.path.splitext(root)
-        ext = second_ext + ext
+if TYPE_CHECKING:
+    from lsst.resources import ResourcePathExpression
 
-    return root, ext
+log = logging.getLogger(__name__)
 
 
 def write_sidecar_file(
-    file: str,
+    file: ResourcePathExpression,
     hdrnum: int,
     content_mode: str,
     print_trace: bool,
@@ -62,7 +39,7 @@ def write_sidecar_file(
 
     Parameters
     ----------
-    file : `str`
+    file : `str` or `lsst.resources.ResourcePathExpression`
         The file from which the header is to be read.
     hdrnum : `int`
         The HDU number to read. The primary header is always read and
@@ -103,12 +80,11 @@ def write_sidecar_file(
             return False
 
         # Calculate sidecar file name derived from this file.
-        # Match the ButlerURI behavior in that .fits.gz should be replaced
+        # .fits.gz should be replaced
         # with .json, and not resulting in .fits.json.
-        root, ext = _split_ext(file)
-        newfile = root + ".json"
-        with open(newfile, "w") as fd:
-            print(json_str, file=fd)
+        uri = ResourcePath(file)
+        newfile = uri.updatedExtension(".json")
+        newfile.write(str(json_str).encode())
         log.debug("Writing sidecar file %s", newfile)
 
     except Exception as e:
@@ -169,8 +145,8 @@ def write_sidecar_files(
     for path in sorted(found_files):
         isok = write_sidecar_file(path, hdrnum, content_mode, print_trace, outstream)
         if isok:
-            okay.append(path)
+            okay.append(str(path))
         else:
-            failed.append(path)
+            failed.append(str(path))
 
     return okay, failed

astro_metadata_translator/file_helpers.py

@@ -20,16 +20,21 @@ __all__ = ("find_files", "read_basic_metadata_from_file", "read_file_info")
 
 import json
 import logging
-import os
 import re
 import traceback
 from collections.abc import Iterable, MutableMapping
-from typing import IO, Any
+from typing import IO, TYPE_CHECKING, Any
+
+from astropy.io import fits
+from lsst.resources import ResourcePath
 
 from .headers import merge_headers
 from .observationInfo import ObservationInfo
 from .tests import read_test_file
 
+if TYPE_CHECKING:
+    from lsst.resources import ResourcePathExpression
+
 log = logging.getLogger(__name__)
 
 # Prefer afw over Astropy
@@ -37,30 +42,15 @@ try:
     import lsst.daf.base  # noqa: F401 need PropertyBase for readMetadata
     from lsst.afw.fits import FitsError, readMetadata
 
-    def _read_fits_metadata(file: str, hdu: int, can_raise: bool = False) -> MutableMapping[str, Any] | None:
-        """Read a FITS header using afw.
-
-        Parameters
-        ----------
-        file : `str`
-            The file to read.
-        hdu : `int`
-            The header number to read.
-        can_raise : `bool`, optional
-            Indicate whether the function can raise and exception (default)
-            or should return `None` on error. Can still raise if an unexpected
-            error is encountered.
-
-        Returns
-        -------
-        md : `dict`
-            The requested header. `None` if it could not be read and
-            ``can_raise`` is `False`.
-
-        Notes
-        -----
-        Tries to catch a FitsError 104 and convert to `FileNotFoundError`.
-        """
+    have_afw = True
+
+    def _read_fits_metadata_afw(
+        file: str, hdu: int, can_raise: bool = False
+    ) -> MutableMapping[str, Any] | None:
+        # Only works with local files.
+        # Tries to catch a FitsError 104 and convert to `FileNotFoundError`.
+        # For detailed docstrings see the _read_fits_metadata implementation
+        # below.
         try:
             return readMetadata(file, hdu=hdu)
         except FitsError as e:
@@ -72,31 +62,84 @@ try:
             return None
 
 except ImportError:
-    from astropy.io import fits
+    have_afw = False
+
+
+def _read_fits_metadata_astropy(
+    file: ResourcePathExpression, hdu: int, can_raise: bool = False
+) -> MutableMapping[str, Any] | None:
+    """Read a FITS header using astropy.
+
+    Parameters
+    ----------
+    file : `str` or `lsst.resources.ResourcePathExpression`
+        The file to read.
+    hdu : `int`
+        The header number to read.
+    can_raise : `bool`, optional
+        Indicate whether the function can raise and exception (default)
+        or should return `None` on error. Can still raise if an unexpected
+        error is encountered.
+
+    Returns
+    -------
+    md : `dict`
+        The requested header. `None` if it could not be read and
+        ``can_raise`` is `False`.
+    """
+    header = None
+    uri = ResourcePath(file, forceDirectory=False)
+    try:
+        fs, fspath = uri.to_fsspec()
+        with fs.open(fspath) as f, fits.open(f) as fits_file:
+            try:
+                # Copy forces a download of the remote resource.
+                header = fits_file[hdu].header.copy()
+            except IndexError as e:
+                if can_raise:
+                    raise e
+    except Exception as e:
+        if can_raise:
+            raise e
+    return header
 
-    def _read_fits_metadata(file: str, hdu: int, can_raise: bool = False) -> MutableMapping[str, Any] | None:
-        """Read a FITS header using astropy."""
-        # For detailed docstrings see the afw implementation above
-        header = None
-        try:
-            with fits.open(file) as fits_file:
-                try:
-                    header = fits_file[hdu].header
-                except IndexError as e:
-                    if can_raise:
-                        raise e
-        except Exception as e:
-            if can_raise:
-                raise e
-        return header
 
+def _read_fits_metadata(
+    file: ResourcePathExpression, hdu: int, can_raise: bool = False
+) -> MutableMapping[str, Any] | None:
+    """Read a FITS header using afw or astropy.
+
+    Prefer afw for local reads if available.
 
-def find_files(files: Iterable[str], regex: str) -> list[str]:
+    Parameters
+    ----------
+    file : `str` or `lsst.resources.ResourcePathExpression`
+        The file to read.
+    hdu : `int`
+        The header number to read.
+    can_raise : `bool`, optional
+        Indicate whether the function can raise and exception (default)
+        or should return `None` on error. Can still raise if an unexpected
+        error is encountered.
+
+    Returns
+    -------
+    md : `dict`
+        The requested header. `None` if it could not be read and
+        ``can_raise`` is `False`.
+    """
+    uri = ResourcePath(file, forceAbsolute=False)
+    if have_afw and uri.isLocal:
+        return _read_fits_metadata_afw(uri.ospath, hdu, can_raise=can_raise)
+    return _read_fits_metadata_astropy(uri, hdu, can_raise=can_raise)
+
+
+def find_files(files: Iterable[ResourcePathExpression], regex: str) -> list[ResourcePath]:
     """Find files for processing.
 
     Parameters
     ----------
-    files : iterable of `str`
+    files : iterable of `lsst.resources.ResourcePathExpression`
         The files or directories from which the headers are to be read.
     regex : `str`
         Regular expression string used to filter files when a directory is
@@ -104,34 +147,31 @@ def find_files(files: Iterable[str], regex: str) -> list[str]:
 
     Returns
     -------
-    found_files : `list` of `str`
+    found_files : `list` of `lsst.resources.ResourcePath`
         The files that were found.
     """
     file_regex = re.compile(regex)
-    found_files = []
+    found_files: list[ResourcePath] = []
 
     # Find all the files of interest
-    for file in files:
-        if os.path.isdir(file):
-            for root, _, files in os.walk(file):
-                for name in files:
-                    path = os.path.join(root, name)
-                    if os.path.isfile(path) and file_regex.search(name):
-                        found_files.append(path)
+    for candidate in files:
+        uri = ResourcePath(candidate, forceAbsolute=False)
+        if uri.isdir():
+            found_files.extend(ResourcePath.findFileResources([uri], file_filter=file_regex, grouped=False))
         else:
-            found_files.append(file)
+            found_files.append(uri)
 
     return found_files
 
 
 def read_basic_metadata_from_file(
-    file: str, hdrnum: int, can_raise: bool = True
+    file: ResourcePathExpression, hdrnum: int, can_raise: bool = True
 ) -> MutableMapping[str, Any] | None:
     """Read a raw header from a file, merging if necessary.
 
     Parameters
     ----------
-    file : `str`
+    file : `str` or `lsst.resources.ResourcePathExpression`
         Name of file to read. Can be FITS, YAML or JSON. YAML or JSON must be
         a simple top-level dict.
     hdrnum : `int`
@@ -151,10 +191,11 @@ def read_basic_metadata_from_file(
         The header as a dict. Can be `None` if there was a problem reading
         the file.
     """
-    if file.endswith(".yaml") or file.endswith(".json"):
+    uri = ResourcePath(file, forceAbsolute=False)
+    if uri.getExtension() in (".yaml", ".json"):
         try:
             md = read_test_file(
-                file,
+                uri,
             )
         except Exception as e:
             if not can_raise:
@@ -165,7 +206,7 @@ def read_basic_metadata_from_file(
             # YAML can't have HDUs so skip merging below
             hdrnum = 0
     else:
-        md = _read_fits_metadata(file, 0, can_raise=can_raise)
+        md = _read_fits_metadata(uri, 0, can_raise=can_raise)
     if md is None:
         log.warning("Unable to open file %s", file)
         return None
@@ -174,19 +215,19 @@ def read_basic_metadata_from_file(
             hdrnum = 1
     if hdrnum > 0:
         # Allow this to fail
-        mdn = _read_fits_metadata(file, int(hdrnum), can_raise=False)
+        mdn = _read_fits_metadata(uri, int(hdrnum), can_raise=False)
         # Astropy does not allow append mode since it does not
         # convert lists to multiple cards. Overwrite for now
         if mdn is not None:
             md = merge_headers([md, mdn], mode="overwrite")
         else:
-            log.warning("HDU %d was not found in file %s. Ignoring request.", hdrnum, file)
+            log.warning("HDU %d was not found in file %s. Ignoring request.", hdrnum, uri)
 
     return md
 
 
 def read_file_info(
-    file: str,
+    file: ResourcePathExpression,
     hdrnum: int,
     print_trace: bool | None = None,
     content_mode: str = "translated",
@@ -232,9 +273,10 @@ def read_file_info(
     if content_type not in ("native", "simple", "json"):
         raise ValueError(f"Unrecognized content type request {content_type}")
 
+    uri = ResourcePath(file, forceAbsolute=False)
     try:
         # Calculate the JSON from the file
-        md = read_basic_metadata_from_file(file, hdrnum, can_raise=True if print_trace is None else False)
+        md = read_basic_metadata_from_file(uri, hdrnum, can_raise=True if print_trace is None else False)
         if md is None:
             return None
         if content_mode == "metadata":
@@ -249,7 +291,7 @@ def read_file_info(
                     json_str = json.dumps(dict(md))
                 return json_str
             return md
-        obs_info = ObservationInfo(md, pedantic=True, filename=file)
+        obs_info = ObservationInfo(md, pedantic=True, filename=str(uri))
         if content_type == "native":
             return obs_info
         simple = obs_info.to_simple()

astro_metadata_translator/indexing.py

@@ -22,19 +22,22 @@ __all__ = (
     "read_sidecar",
 )
 
-import collections.abc
 import json
 import logging
-import os
 from collections.abc import MutableMapping, Sequence
 from copy import deepcopy
-from typing import IO, Any, Literal, overload
+from typing import IO, TYPE_CHECKING, Any, Literal, overload
+
+from lsst.resources import ResourcePath
 
 from .file_helpers import read_file_info
 from .headers import merge_headers
 from .observationGroup import ObservationGroup
 from .observationInfo import ObservationInfo
 
+if TYPE_CHECKING:
+    from lsst.resources import ResourcePathExpression
+
 log = logging.getLogger(__name__)
 
 COMMON_KEY = "__COMMON__"
@@ -42,8 +45,8 @@ CONTENT_KEY = "__CONTENT__"
 
 
 def index_files(
-    files: Sequence[str],
-    root: str | None,
+    files: Sequence[ResourcePathExpression],
+    root: ResourcePathExpression | None,
     hdrnum: int,
     print_trace: bool,
     content: str,
@@ -56,7 +59,7 @@ def index_files(
 
     Parameters
     ----------
-    files : iterable of `str`
+    files : iterable of `lsst.resources.ResourcePathExpression`
         Paths to the files to be indexed. They do not have to all be
         in a single directory but all content will be indexed into a single
         index.
@@ -99,19 +102,22 @@ def index_files(
 
     failed: list[str] = []
     okay: list[str] = []
+    root_uri = ResourcePath(root, forceDirectory=True) if root else None
 
     content_by_file: MutableMapping[str, MutableMapping[str, Any]] = {}  # Mapping of path to file content
     for file in sorted(files):
-        if root is not None:
-            path = os.path.join(root, file)
+        uri = ResourcePath(file, forceAbsolute=False, forceDirectory=False)
+        if root_uri is not None:
+            path = root_uri.join(uri)
         else:
-            path = file
+            path = uri
         simple = read_file_info(path, hdrnum, print_trace, content, "simple", outstream)
+        path_key = path.ospath if path.isLocal else str(path)
         if simple is None:
-            failed.append(path)
+            failed.append(path_key)
             continue
         else:
-            okay.append(path)
+            okay.append(path_key)
 
         # Store the information indexed by the filename within dir
         # We may get a PropertyList here and can therefore not just
@@ -119,7 +125,13 @@ def index_files(
         # other 2 options, which we were enforcing with the "simple" parameter
         # in the call to read_file_info.
         assert not isinstance(simple, str | ObservationInfo)
-        content_by_file[file] = simple
+        # Force string as key since this is required to be a relative path.
+        # Make it relative to the given directory, else it might be absolute.
+        if root_uri is not None:
+            relative = path.relative_to(root_uri)
+            if relative is not None:
+                path_key = relative
+        content_by_file[path_key] = simple
 
     output = calculate_index(content_by_file, content)
 
@@ -154,9 +166,10 @@ def calculate_index(
     # For a single file it is possible that the merged contents
     # are not a dict but are an LSST-style PropertyList. JSON needs
     # dict though.  mypy can't know about PropertyList so we must ignore
-    # the type error.
-    if not isinstance(merged, collections.abc.Mapping):
-        merged = dict(merged)  # type: ignore
+    # the type error. We also need to force Astropy Header to a dict.
+    if not isinstance(merged, dict):
+        # dict(Header) brings along additional keys that can't be serialized.
+        merged = {k: v for k, v in merged.items()}
 
     # The structure to write to file is intended to look like (in YAML):
     # __COMMON__:

astro_metadata_translator/tests.py

@@ -14,7 +14,6 @@ from __future__ import annotations
 __all__ = ("MetadataAssertHelper", "read_test_file")
 
 import json
-import os
 import pickle
 import warnings
 from collections.abc import MutableMapping
@@ -26,6 +25,7 @@ import yaml
 from astropy.io.fits import Header
 from astropy.io.fits.verify import VerifyWarning
 from astropy.time import Time
+from lsst.resources import ResourcePath
 
 from astro_metadata_translator import ObservationInfo
 
@@ -43,6 +43,9 @@ try:
 except AttributeError:
     Loader = yaml.Loader
 
+if TYPE_CHECKING:
+    from lsst.resources import ResourcePathExpression
+
 
 # Define a YAML loader for lsst.daf.base.PropertySet serializations that
 # we can use if daf_base is not available.
@@ -79,12 +82,14 @@ if daf_base is None:
     yaml.add_constructor("lsst.daf.base.PropertyList", pl_constructor, Loader=Loader)  # type: ignore
 
 
-def read_test_file(filename: str, dir: str | None = None) -> MutableMapping[str, Any]:
+def read_test_file(
+    filename: ResourcePathExpression, dir: ResourcePathExpression | None = None
+) -> MutableMapping[str, Any]:
     """Read the named test file relative to the location of this helper.
 
     Parameters
     ----------
-    filename : `str`
+    filename : `str` or `lsst.resources.ResourcePathExpression`
         Name of file in the data directory.
     dir : `str`, optional
         Directory from which to read file. Current directory used if none
@@ -95,15 +100,18 @@ def read_test_file(filename: str, dir: str | None = None) -> MutableMapping[str,
     header : `dict`-like
         Header read from file.
     """
-    if dir is not None and not os.path.isabs(filename):
-        filename = os.path.join(dir, filename)
-    with open(filename) as fd:
-        if filename.endswith(".yaml"):
-            header = yaml.load(fd, Loader=Loader)
-        elif filename.endswith(".json"):
-            header = json.load(fd)
-        else:
-            raise RuntimeError(f"Unrecognized file format: {filename}")
+    uri = ResourcePath(filename, forceAbsolute=False, forceDirectory=False)
+    if dir is not None and not uri.isabs():
+        test_dir = ResourcePath(dir, forceDirectory=True)
+        uri = test_dir.join(uri, forceDirectory=False)
+    content = uri.read()
+    ext = uri.getExtension()
+    if ext == ".yaml":
+        header = yaml.load(content, Loader=Loader)
+    elif ext == ".json":
+        header = json.loads(content)
+    else:
+        raise RuntimeError(f"Unrecognized file format: {uri}")
 
     # Cannot directly check for Mapping because PropertyList is not one
     if not hasattr(header, "items"):

astro_metadata_translator/translator.py

@@ -35,6 +35,7 @@ from .properties import PROPERTIES, PropertyDefinition
 
 if TYPE_CHECKING:
     import astropy.coordinates
+    from lsst.resources import ResourcePathExpression
 
 log = logging.getLogger(__name__)
 
@@ -1298,7 +1299,7 @@ class MetadataTranslator:
 
     @classmethod
     def determine_translatable_headers(
-        cls, filename: str, primary: MutableMapping[str, Any] | None = None
+        cls, filename: ResourcePathExpression, primary: MutableMapping[str, Any] | None = None
     ) -> Iterator[MutableMapping[str, Any]]:
         """Given a file return all the headers usable for metadata translation.
 
@@ -1325,7 +1326,7 @@ class MetadataTranslator:
 
         Parameters
         ----------
-        filename : `str`
+        filename : `str` or `lsst.resources.ResourcePathExpression`
             Path to a file in a format understood by this translator.
         primary : `dict`-like, optional
             The primary header obtained by the caller. This is sometimes

astro_metadata_translator/translators/decam.py

@@ -25,6 +25,7 @@ import astropy.time
 import astropy.units as u
 from astropy.coordinates import Angle, EarthLocation, UnknownSiteException
 from astropy.io import fits
+from lsst.resources import ResourcePath
 
 from ..translator import CORRECTIONS_RESOURCE_ROOT, cache_translation
 from .fits import FitsTranslator
@@ -32,6 +33,7 @@ from .helpers import altaz_from_degree_headers, is_non_science, tracking_from_de
 
 if TYPE_CHECKING:
     import astropy.coordinates
+    from lsst.resources import ResourcePathExpression
 
 log = logging.getLogger(__name__)
 
@@ -425,7 +427,7 @@ class DecamTranslator(FitsTranslator):
 
     @classmethod
     def determine_translatable_headers(
-        cls, filename: str, primary: MutableMapping[str, Any] | None = None
+        cls, filename: ResourcePathExpression, primary: MutableMapping[str, Any] | None = None
     ) -> Iterator[MutableMapping[str, Any]]:
         """Given a file return all the headers usable for metadata translation.
 
@@ -438,7 +440,7 @@ class DecamTranslator(FitsTranslator):
 
         Parameters
         ----------
-        filename : `str`
+        filename : `str` or `lsst.resources.ResourcePathExpression`
             Path to a file in a format understood by this translator.
         primary : `dict`-like, optional
             The primary header obtained by the caller. This is sometimes
@@ -472,7 +474,9 @@ class DecamTranslator(FitsTranslator):
         # Since we want to scan many HDUs we use astropy directly to keep
         # the file open rather than continually opening and closing it
         # as we go to each HDU.
-        with fits.open(filename) as fits_file:
+        uri = ResourcePath(filename, forceDirectory=False)
+        fs, fspath = uri.to_fsspec()
+        with fs.open(fspath) as f, fits.open(f) as fits_file:
             # Astropy does not automatically handle the INHERIT=T in
             # DECam headers so the primary header must be merged.
             first_pass = True

astro_metadata_translator/translators/helpers.py

@@ -48,6 +48,11 @@ log = logging.getLogger(__name__)
 def to_location_via_telescope_name(self: MetadataTranslator) -> EarthLocation:
     """Calculate the observatory location via the telescope name.
 
+    Parameters
+    ----------
+    self : `MetadataTranslator`
+        The translator being used.
+
     Returns
     -------
     loc : `astropy.coordinates.EarthLocation`
@@ -59,6 +64,11 @@ def to_location_via_telescope_name(self: MetadataTranslator) -> EarthLocation:
 def is_non_science(self: MetadataTranslator) -> None:
     """Raise an exception if this is a science observation.
 
+    Parameters
+    ----------
+    self : `MetadataTranslator`
+        The translator being used.
+
     Raises
     ------
     KeyError
@@ -94,6 +104,8 @@ def tracking_from_degree_headers(
 
     Parameters
     ----------
+    self : `MetadataTranslator`
+        The translator being used.
     radecsys : `list` or `tuple`
         Header keywords to try corresponding to the tracking system.  If none
         match ICRS will be assumed.
@@ -163,6 +175,8 @@ def altaz_from_degree_headers(
 
     Parameters
     ----------
+    self : `MetadataTranslator`
+        The translator being used.
     altazpairs : `tuple` of `str`
         Pairs of keywords specifying Alt/Az in degrees. Each pair is tried
         in turn.

astro_metadata_translator/translators/megaprime.py

@@ -24,6 +24,7 @@ import astropy.time
 import astropy.units as u
 from astropy.coordinates import Angle, EarthLocation, UnknownSiteException
 from astropy.io import fits
+from lsst.resources import ResourcePath
 
 from ..translator import CORRECTIONS_RESOURCE_ROOT, cache_translation
 from .fits import FitsTranslator
@@ -32,6 +33,7 @@ from .helpers import altaz_from_degree_headers, tracking_from_degree_headers
 if TYPE_CHECKING:
     import astropy.coordinates
     import astropy.units
+    from lsst.resources import ResourcePathExpression
 
 _MK_FALLBACK_LOCATION = EarthLocation.from_geocentric(
     -5464301.77135369, -2493489.8730419, 2151085.16950589, unit=u.m
@@ -213,7 +215,7 @@ class MegaPrimeTranslator(FitsTranslator):
 
     @classmethod
     def determine_translatable_headers(
-        cls, filename: str, primary: MutableMapping[str, Any] | None = None
+        cls, filename: ResourcePathExpression, primary: MutableMapping[str, Any] | None = None
     ) -> Iterator[MutableMapping[str, Any]]:
         """Given a file return all the headers usable for metadata translation.
 
@@ -224,7 +226,7 @@ class MegaPrimeTranslator(FitsTranslator):
 
         Parameters
         ----------
-        filename : `str`
+        filename : `str` or `lsst.resources.ResourcePathExpression`
             Path to a file in a format understood by this translator.
         primary : `dict`-like, optional
             The primary header obtained by the caller. This is sometimes
@@ -250,7 +252,9 @@ class MegaPrimeTranslator(FitsTranslator):
         # Since we want to scan many HDUs we use astropy directly to keep
         # the file open rather than continually opening and closing it
         # as we go to each HDU.
-        with fits.open(filename) as fits_file:
+        uri = ResourcePath(filename, forceDirectory=False)
+        fs, fspath = uri.to_fsspec()
+        with fs.open(fspath) as f, fits.open(f) as fits_file:
             for hdu in fits_file:
                 # Astropy <=4.2 strips the EXTNAME header but some CFHT data
                 # have two EXTNAME headers and the CCD number is in the

astro_metadata_translator/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "29.2025.4200"
+__version__ = "29.2025.4400"

{astro_metadata_translator-29.2025.4200.dist-info → astro_metadata_translator-29.2025.4400.dist-info}/METADATA

@@ -1,25 +1,26 @@
 Metadata-Version: 2.4
 Name: astro-metadata-translator
-Version: 29.2025.4200
+Version: 29.2025.4400
 Summary: A translator for astronomical metadata.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
-License: BSD 3-Clause License
+License-Expression: BSD-3-Clause
 Project-URL: Homepage, https://github.com/lsst/astro_metadata_translator
 Keywords: lsst
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Astronomy
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.10
-Requires-Python: >=3.10.0
+Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: astropy>=3.0.5
 Requires-Dist: pyyaml>=3.13
+Requires-Dist: lsst-resources
+Requires-Dist: fsspec
 Requires-Dist: click>=8
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"

{astro_metadata_translator-29.2025.4200.dist-info → astro_metadata_translator-29.2025.4400.dist-info}/RECORD

@@ -1,18 +1,18 @@
 astro_metadata_translator/__init__.py,sha256=TgZ7RPdgoCQwsGlvIOMcrDTLBPefDVhvkb-S6N5XTWY,595
-astro_metadata_translator/file_helpers.py,sha256=Y8jovSkAjjHIUMbY4gtiEdEZZ8KzHFCXwP2JJLR9p5I,9440
+astro_metadata_translator/file_helpers.py,sha256=jAqiwCr3HzdA-ruLfMZz6pOFxaUIojmjn-dk4bXVT7A,10913
 astro_metadata_translator/headers.py,sha256=21KWaPnBPDkonh5coZ0NolMdtM6KVozqi1Fd2d1z80M,18944
-astro_metadata_translator/indexing.py,sha256=GxQNDJ_-YVqNBAbaUFku6MrzgKrcS7yTLUO498b3rCM,14530
+astro_metadata_translator/indexing.py,sha256=WcltI-8Jiu7JzKcn_xtT1YRAJ7XD_m-WNKY7J2XPVx8,15340
 astro_metadata_translator/observationGroup.py,sha256=XRP8xpHQXx4hSl_SrBBan_q1gmxpu2VuepjLZEWthsQ,8689
 astro_metadata_translator/observationInfo.py,sha256=mlxtrOlJB7qjMZzxVo2-8CjC-KFCexZsBkI_9VtXakI,27543
 astro_metadata_translator/properties.py,sha256=oiatCGP6g7O0sm5dku50dUyMJtu8IORFLXRu4Sx1hCo,18787
 astro_metadata_translator/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-astro_metadata_translator/tests.py,sha256=S73nreZm3pCfRlU8sKHbXfEoEkZ2zSY5pbHs9hDYBAM,13251
-astro_metadata_translator/translator.py,sha256=5dA5Dsj57PxTMtdE-t1jixWHLPkW1BNsdUJhiYfsbNc,56602
-astro_metadata_translator/version.py,sha256=loN_SewEappJtRr1bfMkUAloXYiZtM4w0O03FF5yeZQ,55
+astro_metadata_translator/tests.py,sha256=QCIniK0S0MBnDXudTvH_Z4vSn7ItlIJzOXSRrFafB-4,13552
+astro_metadata_translator/translator.py,sha256=o-MYrRNWwQwidcXcmtQB69ucGHEBhITv33hHBEloTgw,56718
+astro_metadata_translator/version.py,sha256=c_EQrzHIElqjF0MSUCohtezaryfBlqz_McPyAghglVk,55
 astro_metadata_translator/bin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-astro_metadata_translator/bin/translate.py,sha256=uf69YI58nxVI4i-p5nPxPsQWdHlk-QY_WmMBkeeKQB0,11018
-astro_metadata_translator/bin/writeindex.py,sha256=pGdN0Z8WNQKGIFCJz_YHd384nAxVsBKK6JQ1lWQbTN8,4220
-astro_metadata_translator/bin/writesidecar.py,sha256=kPtJ22DvrFQqlSDut7jDZ_hxqaeW57qfpyn0Iq8RXL4,5427
+astro_metadata_translator/bin/translate.py,sha256=RzUBoq4ZfpDx7Xg2O43DmguKELUUY0xMLMUdAe12ctE,11284
+astro_metadata_translator/bin/writeindex.py,sha256=JYNgbrTjy-ExeWmg2EdXNe6zdwaICfQSvMcSFiRPRKM,4586
+astro_metadata_translator/bin/writesidecar.py,sha256=85v_oF4sp3XmA8Rb3mYPhtY-tFLfa1cyd0fvfCINlRE,4938
 astro_metadata_translator/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 astro_metadata_translator/cli/astrometadata.py,sha256=F8MHvWCgykijmOKKpy7YfQv3E5MuJFTl3SNeLHJrosw,9609
 astro_metadata_translator/corrections/CFHT/README.md,sha256=qgf5zPK9NUtlufSPESZgKqizWHH4fIL58IKWbmmjjWQ,190
@@ -50,18 +50,18 @@ astro_metadata_translator/corrections/SuprimeCam/README.md,sha256=UaaDRv8T5ik-iY
 astro_metadata_translator/serialize/__init__.py,sha256=pthEgasrT3Qw4e7nZk_X1rPBjDju5AsdHDnxqoOoAsU,427
 astro_metadata_translator/serialize/fits.py,sha256=mjBYhL_wy_-aGgmswxMn1bIgq0U764uv02ge_1_5iRg,3811
 astro_metadata_translator/translators/__init__.py,sha256=RHzTw7pnp5o5wyZPWg__udthT6qFQMZAJBsicxkRVZY,560
-astro_metadata_translator/translators/decam.py,sha256=R0M_p5EpPVvpeEQk0nSJdd34UJiIUvqBrlbsC_NQbOc,18286
+astro_metadata_translator/translators/decam.py,sha256=03nXEPol97ZTRDitxVMZek8alo7arockSYfTJRgPGXY,18553
 astro_metadata_translator/translators/fits.py,sha256=h4tIB2XIg_oV-m5kVe6ny1gJIKMcDsEBO-SvC_NWinM,7030
-astro_metadata_translator/translators/helpers.py,sha256=SrfI1qo-jLZfsCO60AU9Mft8ecPx8VAq35ap7gv2we0,7478
+astro_metadata_translator/translators/helpers.py,sha256=uK4q3r2dLzzJVJMjlEyT14lQCDogASp0h_lCGmYeMOc,7808
 astro_metadata_translator/translators/hsc.py,sha256=Ca7zKICl04HrKQG51_bWyxAio7Oiibuuw39fcvtG6wI,8529
-astro_metadata_translator/translators/megaprime.py,sha256=n46ZkE95XuybU5JOKhBTE1VIiS-aNwxjuaJxjrz_BH0,10882
+astro_metadata_translator/translators/megaprime.py,sha256=fWbXVh_klB6t1dLJFMqfzX0W8XVoQOgo-M5Yxfy3vUw,11149
 astro_metadata_translator/translators/sdss.py,sha256=prUTawPqAXzJ5i2p2yXH3ekLuj3rWGy-YjJMquJPMq0,9445
 astro_metadata_translator/translators/subaru.py,sha256=-CTzxc2MpgEEpma-toD6B8RcvV-t5MNZq_fb4UGbHQU,2143
 astro_metadata_translator/translators/suprimecam.py,sha256=b3S54aHvZ2SprvXRdOLCIJToj6KAiqjK-JB5My8xLWM,8409
-astro_metadata_translator-29.2025.4200.dist-info/licenses/LICENSE,sha256=6DRIob1hPfPI0HmYxqGJXcJr7Vc81mXQJHtjH29gygw,1518
-astro_metadata_translator-29.2025.4200.dist-info/METADATA,sha256=i-8vIMr7lKEsB9Z36bHERlkM8dAD3KTUm6LLdnfpHNM,1901
-astro_metadata_translator-29.2025.4200.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-astro_metadata_translator-29.2025.4200.dist-info/entry_points.txt,sha256=9dwf9VZWuNtomGwNBEc0S9HJ740wnPSVEO8yNEPto6Y,83
-astro_metadata_translator-29.2025.4200.dist-info/top_level.txt,sha256=ll138q-If3_TxKr2nTm5F3MEhWqvHbF3ptEDOhvgfRU,26
-astro_metadata_translator-29.2025.4200.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-astro_metadata_translator-29.2025.4200.dist-info/RECORD,,
+astro_metadata_translator-29.2025.4400.dist-info/licenses/LICENSE,sha256=6DRIob1hPfPI0HmYxqGJXcJr7Vc81mXQJHtjH29gygw,1518
+astro_metadata_translator-29.2025.4400.dist-info/METADATA,sha256=uHFtTQtW43XvoksqzVbKiXy4S6pWl-7rymU56Q7OsmQ,1905
+astro_metadata_translator-29.2025.4400.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+astro_metadata_translator-29.2025.4400.dist-info/entry_points.txt,sha256=9dwf9VZWuNtomGwNBEc0S9HJ740wnPSVEO8yNEPto6Y,83
+astro_metadata_translator-29.2025.4400.dist-info/top_level.txt,sha256=ll138q-If3_TxKr2nTm5F3MEhWqvHbF3ptEDOhvgfRU,26
+astro_metadata_translator-29.2025.4400.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+astro_metadata_translator-29.2025.4400.dist-info/RECORD,,