lsst-felis 26.2024.900__py3-none-any.whl → 29.2025.4500__py3-none-any.whl

felis/tests/postgresql.py

@@ -0,0 +1,134 @@
+"""Provides a temporary Postgresql instance for testing."""
+
+# This file is part of felis.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import gc
+import unittest
+from collections.abc import Iterator
+from contextlib import contextmanager
+
+from sqlalchemy import text
+from sqlalchemy.engine import Connection, Engine, create_engine
+
+try:
+    from testing.postgresql import Postgresql  # type: ignore
+except ImportError:
+    Postgresql = None
+
+__all__ = ["TemporaryPostgresInstance", "setup_postgres_test_db"]
+
+
+class TemporaryPostgresInstance:
+    """Wrapper for a temporary Postgres database.
+
+    Parameters
+    ----------
+    server
+        The ``testing.postgresql.Postgresql`` instance.
+    engine
+        The SQLAlchemy engine for the temporary database server.
+
+    Notes
+    -----
+    This class was copied and modified from
+    ``lsst.daf.butler.tests.postgresql``.
+    """
+
+    def __init__(self, server: Postgresql, engine: Engine) -> None:
+        """Initialize the temporary Postgres database instance."""
+        self._server = server
+        self._engine = engine
+
+    @property
+    def url(self) -> str:
+        """Return connection URL for the temporary database server.
+
+        Returns
+        -------
+        str
+            The connection URL.
+        """
+        return self._server.url()
+
+    @property
+    def engine(self) -> Engine:
+        """Return the SQLAlchemy engine for the temporary database server.
+
+        Returns
+        -------
+        `~sqlalchemy.engine.Engine`
+            The SQLAlchemy engine.
+        """
+        return self._engine
+
+    @contextmanager
+    def begin(self) -> Iterator[Connection]:
+        """Return a SQLAlchemy connection to the test database.
+
+        Returns
+        -------
+        `~sqlalchemy.engine.Connection`
+            The SQLAlchemy connection.
+        """
+        with self._engine.begin() as connection:
+            yield connection
+
+    def print_info(self) -> None:
+        """Print information about the temporary database server."""
+        print("\n\n---- PostgreSQL URL ----")
+        print(self.url)
+        self._engine = create_engine(self.url)
+        with self.begin() as conn:
+            print("\n---- PostgreSQL Version ----")
+            res = conn.execute(text("SELECT version()")).fetchone()
+            if res:
+                print(res[0])
+            print("\n")
+
+
+@contextmanager
+def setup_postgres_test_db() -> Iterator[TemporaryPostgresInstance]:
+    """Set up a temporary Postgres database instance that can be used for
+    testing.
+
+    Returns
+    -------
+    TemporaryPostgresInstance
+        The temporary Postgres database instance.
+
+    Raises
+    ------
+    unittest.SkipTest
+        Raised if the ``testing.postgresql`` module is not available.
+    """
+    if Postgresql is None:
+        raise unittest.SkipTest("testing.postgresql module not available.")
+
+    with Postgresql() as server:
+        engine = create_engine(server.url())
+        instance = TemporaryPostgresInstance(server, engine)
+        yield instance
+
+        # Clean up any lingering SQLAlchemy engines/connections
+        # so they're closed before we shut down the server.
+        gc.collect()
+        engine.dispose()

felis/tests/run_cli.py

@@ -0,0 +1,79 @@
+"""Test utility for running cli commands."""
+
+# This file is part of felis.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import logging
+
+from click.testing import CliRunner
+
+from felis.cli import cli
+
+__all__ = ["run_cli"]
+
+
+def run_cli(
+    cmd: list[str],
+    log_level: int = logging.WARNING,
+    catch_exceptions: bool = False,
+    expect_error: bool = False,
+    print_cmd: bool = False,
+    print_output: bool = False,
+    id_generation: bool = False,
+) -> None:
+    """Run a CLI command and check the exit code.
+
+    Parameters
+    ----------
+    cmd : list[str]
+        The command to run.
+    log_level : int
+        The logging level to use, by default logging.WARNING.
+    catch_exceptions : bool
+        Whether to catch exceptions, by default False.
+    expect_error : bool
+        Whether to expect an error, by default False.
+    print_cmd : bool
+        Whether to print the command, by default False.
+    print_output : bool
+        Whether to print the output, by default False.
+    id_generation : bool
+        Whether to enable id generation, by default False.
+    """
+    if not cmd:
+        raise ValueError("No command provided.")
+    full_cmd = ["--log-level", logging.getLevelName(log_level)] + cmd
+    if id_generation:
+        full_cmd = ["--id-generation"] + full_cmd
+    if print_cmd:
+        print(f"Running command: felis {' '.join(full_cmd)}")
+    runner = CliRunner()
+    result = runner.invoke(
+        cli,
+        full_cmd,
+        catch_exceptions=catch_exceptions,
+    )
+    if print_output:
+        print(result.output)
+    if expect_error:
+        assert result.exit_code != 0
+    else:
+        assert result.exit_code == 0

felis/types.py

@@ -1,3 +1,5 @@
+"""Define the supported Felis datatypes."""
+
 # This file is part of felis.
 #
 # Developed for the LSST Data Management System.
@@ -23,10 +25,29 @@ from __future__ import annotations
 
 from typing import Any
 
+__all__ = [
+    "Binary",
+    "Boolean",
+    "Byte",
+    "Char",
+    "Double",
+    "FelisType",
+    "Float",
+    "Int",
+    "Long",
+    "Short",
+    "String",
+    "Text",
+    "Timestamp",
+    "Unicode",
+]
+
 
 class FelisType:
-    """Base class for types that represent Felis column types.
+    """Base class for a representation of Felis column types.
 
+    Notes
+    -----
     This class plays a role of a metaclass without being an actual metaclass.
     It provides a method to retrieve a class (type) given Felis type name.
     There should be no instances of this class (or sub-classes), the utility
@@ -34,12 +55,22 @@ class FelisType:
     """
 
     felis_name: str
+    """Name of the type as defined in the Felis schema."""
+
     votable_name: str
+    """Name of the type as defined in VOTable."""
+
     is_numeric: bool
+    """Flag indicating if the type is numeric."""
+
     is_sized: bool
+    """Flag indicating if the type is sized, meaning it requires a length."""
+
     is_timestamp: bool
+    """Flag indicating if the type is a timestamp."""
 
     _types: dict[str, type[FelisType]] = {}
+    """Dictionary of all known Felis types."""
 
     @classmethod
     def __init_subclass__(
@@ -52,6 +83,23 @@ class FelisType:
         is_timestamp: bool = False,
         **kwargs: Any,
     ):
+        """Register a new Felis type.
+
+        Parameters
+        ----------
+        felis_name
+            Name of the type.
+        votable_name
+            Name of the type as defined in VOTable.
+        is_numeric
+            Flag indicating if the type is numeric.
+        is_sized
+            Flag indicating if the type is sized.
+        is_timestamp
+            Flag indicating if the type is a timestamp.
+        kwargs
+            Additional keyword arguments.
+        """
         super().__init_subclass__(**kwargs)
         cls.felis_name = felis_name
         cls.votable_name = votable_name
@@ -62,17 +110,17 @@ class FelisType:
 
     @classmethod
     def felis_type(cls, felis_name: str) -> type[FelisType]:
-        """Return specific Felis type for a given type name.
+        """Return specific Felis type for a given name.
 
         Parameters
         ----------
-        felis_name : `str`
-            name of the felis type as defined in felis schema.
+        felis_name
+            Name of the felis type as defined in felis schema.
 
         Returns
         -------
-        felis_type : `type`
-            One of subclasses of `FelisType`.
+        `type` [ `FelisType` ]
+            A specific Felis type class.
 
         Raises
         ------
@@ -106,11 +154,11 @@ class Long(FelisType, felis_name="long", votable_name="long", is_numeric=True):
 
 
 class Float(FelisType, felis_name="float", votable_name="float", is_numeric=True):
-    """Felis definition of single precision floating type."""
+    """Felis definition of single precision floating point type."""
 
 
 class Double(FelisType, felis_name="double", votable_name="double", is_numeric=True):
-    """Felis definition of double precision floating type."""
+    """Felis definition of double precision floating point type."""
 
 
 class Char(FelisType, felis_name="char", votable_name="char", is_sized=True):
@@ -125,7 +173,7 @@ class Unicode(FelisType, felis_name="unicode", votable_name="unicodeChar", is_si
     """Felis definition of unicode string type."""
 
 
-class Text(FelisType, felis_name="text", votable_name="unicodeChar", is_sized=True):
+class Text(FelisType, felis_name="text", votable_name="char"):
     """Felis definition of text type."""
 
 

lsst_felis-29.2025.4500.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: lsst-felis
+Version: 29.2025.4500
+Summary: A vocabulary for describing catalogs and acting on those descriptions
+Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
+License-Expression: GPL-3.0-or-later
+Project-URL: Homepage, https://felis.lsst.io
+Project-URL: Source, https://github.com/lsst/felis
+Keywords: lsst
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Requires-Python: >=3.11.0
+Description-Content-Type: text/markdown
+License-File: COPYRIGHT
+License-File: LICENSE
+Requires-Dist: alembic
+Requires-Dist: astropy
+Requires-Dist: click
+Requires-Dist: deepdiff
+Requires-Dist: lsst-resources
+Requires-Dist: lsst-utils
+Requires-Dist: numpy
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: pyyaml
+Requires-Dist: sqlalchemy
+Provides-Extra: test
+Requires-Dist: pytest>=3.2; extra == "test"
+Provides-Extra: dev
+Requires-Dist: documenteer[guide]<2; extra == "dev"
+Requires-Dist: autodoc_pydantic; extra == "dev"
+Requires-Dist: sphinx-click; extra == "dev"
+Dynamic: license-file

lsst_felis-29.2025.4500.dist-info/RECORD

@@ -0,0 +1,31 @@
+felis/__init__.py,sha256=HnwWzLaPOSnPzAoppSIHzTrGfixEgvkzJdBxa8-03cw,1294
+felis/cli.py,sha256=g6OrBrIylNLiflSvrLlef86BjoiehV3L5eAvVPrxPog,16911
+felis/datamodel.py,sha256=VAJ9DqOBtfu3fWtpDOcpg4Ca1jfq8NMG6MHH8GbHpl0,52135
+felis/diff.py,sha256=ZzjOJ57p5ZwFn6eem7CYoPjSnxti5OZY33B6Ds5Q-Rg,7797
+felis/metadata.py,sha256=79YcaIqeFP-pj9zhWpqXlvw_piUTUwuLrV5_8eVYalQ,13763
+felis/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+felis/tap_schema.py,sha256=Kfpnv6AO_ni_B-DEgi3PRSkGKkTEybuYfWlA9gOMM_I,27071
+felis/types.py,sha256=ifZQjc-Uw5CM3L7hmFUb7wcHY1O_HgJCw6HPqyUkHvk,5510
+felis/config/tap_schema/columns.csv,sha256=9RsyuPObUQ_6myux9vKtlQ-aJgs7rvvxoLf6yYSRWqc,3272
+felis/config/tap_schema/key_columns.csv,sha256=dRezco5ltcM1mG--2DvPsbOxB6cwVaBwczwi3It2vag,210
+felis/config/tap_schema/keys.csv,sha256=6zTXyo-1GNfu5sBWpX-7ZJFAtHrxOys78AViCcdPgu8,377
+felis/config/tap_schema/schemas.csv,sha256=z5g1bW1Y9H8nKLZyH4e5xiBBoK9JezR2Xf8L79K2TZk,138
+felis/config/tap_schema/tables.csv,sha256=o0KioOiL7hw9ntCyKWili-iFMjAaGRMUOE-nM30LBD0,510
+felis/config/tap_schema/tap_schema_std.yaml,sha256=sPW-Vk72nY0PFpCvP5d8L8fWvhkif-x32sGtcfDZ8bU,7131
+felis/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+felis/db/dialects.py,sha256=XTZEbTnfy96GJDNRLCQMbAV6irerC87vhO_HyTIXLbs,3517
+felis/db/schema.py,sha256=NOFXzBoBQcgpoRlgT3LoC70FKp7pCSmFEJ7rU8FIT-c,2101
+felis/db/sqltypes.py,sha256=Q2p3Af3O5-B1ZxQ4M2j_w8SH1o_kp6ezg8h7LmSlfww,11060
+felis/db/utils.py,sha256=jiKQ_SirKRdQITHe8gSiT_i3ckRHZbkAnwUlEHk2u4Y,14116
+felis/db/variants.py,sha256=eahthrbVeV8ZdGamWQccNmWgx6CCscGrU0vQRs5HZK8,5260
+felis/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+felis/tests/postgresql.py,sha256=B_xk4fLual5-viGDqP20r94okuc0pbSvytRH_L0fvMs,4035
+felis/tests/run_cli.py,sha256=Gg8loUIGj9t6KlkRKrEc9Z9b5dtlkpJy94ORuj4BrxU,2503
+lsst_felis-29.2025.4500.dist-info/licenses/COPYRIGHT,sha256=vJAFLFTSF1mhy9eIuA3P6R-3yxTWKQgpig88P-1IzRw,129
+lsst_felis-29.2025.4500.dist-info/licenses/LICENSE,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+lsst_felis-29.2025.4500.dist-info/METADATA,sha256=_brJSKPh9-Izo-XR_3FTFQb_zfsnECQyL2t6gjLW6p8,1377
+lsst_felis-29.2025.4500.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+lsst_felis-29.2025.4500.dist-info/entry_points.txt,sha256=Gk2XFujA_Gp52VBk45g5kim8TDoMDJFPctsMqiq72EM,40
+lsst_felis-29.2025.4500.dist-info/top_level.txt,sha256=F4SvPip3iZRVyISi50CHhwTIAokAhSxjWiVcn4IVWRI,6
+lsst_felis-29.2025.4500.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+lsst_felis-29.2025.4500.dist-info/RECORD,,

{lsst_felis-26.2024.900.dist-info → lsst_felis-29.2025.4500.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{lsst_felis-26.2024.900.dist-info → lsst_felis-29.2025.4500.dist-info/licenses}/COPYRIGHT

@@ -1 +1 @@
-Copyright 2020-2022 The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory
+Copyright 2018-2024 The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory