Merge pull request #85 from kurtmckee/release/0.11.0

kurtmckee · web-flow · commit 27c81cc6c1cc · 2025-05-14T09:49:17.000-05:00
Release v0.11.0
diff --git a/.editorconfig b/.editorconfig
@@ -8,7 +8,7 @@ indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
 
-[{*.yml,*.yaml}]
+[{*.yml,*.yaml,*.cff}]
 indent_size = 2
 
 # Character encoding exceptions
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -47,19 +47,19 @@ repos:
       - id: "isort"
 
   - repo: "https://github.com/pycqa/flake8"
-    rev: "7.1.2"
+    rev: "7.2.0"
     hooks:
       - id: "flake8"
         additional_dependencies:
           - "flake8-bugbear==24.12.12"
 
   - repo: "https://github.com/editorconfig-checker/editorconfig-checker"
-    rev: "v3.2.1"
+    rev: "v3.3.0"
     hooks:
       - id: "editorconfig-checker"
 
   - repo: "https://github.com/python-jsonschema/check-jsonschema"
-    rev: "0.31.3"
+    rev: "0.33.0"
     hooks:
       - id: "check-dependabot"
       - id: "check-readthedocs"
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -25,6 +25,31 @@ Please see the fragment files in the `changelog.d directory`_.
 
 ..  scriv-insert-here
 
+.. _changelog-0.11.0:
+
+0.11.0 - 2025-05-14
+===================
+
+Fixed
+-----
+
+*   Fix a crash that occurs when CLI extras are not installed.
+
+    This restores the user-friendly warning message behavior
+    when ``[cli]`` extras are not installed.
+
+Changed
+-------
+
+*   A ``FileNotFoundError`` subclass is now raised when a file isn't found.
+
+    Previously, a ``TypeError`` was implicitly raised due to the structure of the code.
+
+Documentation
+-------------
+
+*   Add a ``CITATION.cff`` file.
+
 .. _changelog-0.10.0:
 
 0.10.0 - 2025-03-25
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,16 @@
+cff-version: '1.2.0'
+message: 'If you use this software, please cite it using the metadata from this file.'
+type: 'software'
+title: 'sqliteimport'
+abstract: 'Import Python code from sqlite databases.'
+authors:
+  - given-names: 'Kurt'
+    family-names: 'McKee'
+    email: 'contactme@kurtmckee.org'
+    orcid: 'https://orcid.org/0000-0002-8547-8489'
+license: 'MIT'
+repository-code: 'https://github.com/kurtmckee/sqliteimport'
+url: 'https://sqliteimport.readthedocs.io/'
+keywords:
+  - 'python'
+  - 'sqlite'
diff --git a/README.rst b/README.rst
@@ -5,7 +5,7 @@
 
 
 ..  image:: https://raw.githubusercontent.com/kurtmckee/sqliteimport/dfd7095f2df8d6e9249889dd85f102027d1a6cfb/docs/_static/banner.png
-    :alt: sqlite import: Import Python code in sqlite databases.
+    :alt: sqlite import: Import Python code from sqlite databases.
 
 -------------------------------------------------------------------------------
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,7 @@ sqliteimport
 ############
 
 ..  image:: _static/banner.png
-    :alt: sqlite import: Import Python code in sqlite databases.
+    :alt: sqlite import: Import Python code from sqlite databases.
 
 -------------------------------------------------------------------------------
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "sqliteimport"
-version = "0.10.0"
+version = "0.11.0"
 description = "Import Python code from sqlite databases"
 authors = [
     { name = "Kurt McKee", email = "contactme@kurtmckee.org" },
@@ -61,7 +61,7 @@ source = [
 
 [tool.coverage.report]
 skip_covered = true
-fail_under = 49
+fail_under = 60
 
 
 # isort
@@ -75,6 +75,7 @@ extend_skip_glob = [
     "docs/isort/*",
 ]
 
+
 # mypy
 # ----
 
@@ -88,6 +89,7 @@ sqlite_cache = true
 # ------
 
 [tool.pytest.ini_options]
+testpaths = ["tests"]
 addopts = "--color=yes"
 filterwarnings = [
     "error",
diff --git a/requirements/docs-integrations/requirements.txt b/requirements/docs-integrations/requirements.txt
@@ -1,5 +1,5 @@
-flake8==7.1.2 ; python_version >= "3.9"
+flake8==7.2.0 ; python_version >= "3.9"
 isort==6.0.1 ; python_version >= "3.9"
 mccabe==0.7.0 ; python_version >= "3.9"
-pycodestyle==2.12.1 ; python_version >= "3.9"
-pyflakes==3.2.0 ; python_version >= "3.9"
+pycodestyle==2.13.0 ; python_version >= "3.9"
+pyflakes==3.3.2 ; python_version >= "3.9"
diff --git a/requirements/docs/requirements.txt b/requirements/docs/requirements.txt
@@ -1,18 +1,18 @@
 alabaster==0.7.16 ; python_version >= "3.9"
 babel==2.17.0 ; python_version >= "3.9"
-certifi==2025.1.31 ; python_version >= "3.9"
-charset-normalizer==3.4.1 ; python_version >= "3.9"
+certifi==2025.4.26 ; python_version >= "3.9"
+charset-normalizer==3.4.2 ; python_version >= "3.9"
 colorama==0.4.6 ; python_version >= "3.9" and sys_platform == "win32"
 docutils==0.21.2 ; python_version >= "3.9"
 idna==3.10 ; python_version >= "3.9"
 imagesize==1.4.1 ; python_version >= "3.9"
-importlib-metadata==8.6.1 ; python_version == "3.9"
+importlib-metadata==8.7.0 ; python_version == "3.9"
 jinja2==3.1.6 ; python_version >= "3.9"
 markupsafe==3.0.2 ; python_version >= "3.9"
-packaging==24.2 ; python_version >= "3.9"
+packaging==25.0 ; python_version >= "3.9"
 pygments==2.19.1 ; python_version >= "3.9"
 requests==2.32.3 ; python_version >= "3.9"
-snowballstemmer==2.2.0 ; python_version >= "3.9"
+snowballstemmer==3.0.1 ; python_version >= "3.9"
 sphinx==7.4.7 ; python_version >= "3.9"
 sphinxcontrib-applehelp==2.0.0 ; python_version >= "3.9"
 sphinxcontrib-devhelp==2.0.0 ; python_version >= "3.9"
@@ -21,5 +21,5 @@ sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9"
 sphinxcontrib-qthelp==2.0.0 ; python_version >= "3.9"
 sphinxcontrib-serializinghtml==2.0.0 ; python_version >= "3.9"
 tomli==2.2.1 ; python_version >= "3.9" and python_version < "3.11"
-urllib3==2.3.0 ; python_version >= "3.9"
+urllib3==2.4.0 ; python_version >= "3.9"
 zipp==3.21.0 ; python_version == "3.9"
diff --git a/requirements/mypy/requirements.txt b/requirements/mypy/requirements.txt
@@ -1,4 +1,4 @@
-mypy-extensions==1.0.0 ; python_version >= "3.9"
+mypy-extensions==1.1.0 ; python_version >= "3.9"
 mypy==1.15.0 ; python_version >= "3.9"
 tomli==2.2.1 ; python_version >= "3.9" and python_version < "3.11"
-typing-extensions==4.12.2 ; python_version >= "3.9"
+typing-extensions==4.13.2 ; python_version >= "3.9"
diff --git a/requirements/regenerate-test-projects/requirements.txt b/requirements/regenerate-test-projects/requirements.txt
@@ -1,8 +1,8 @@
 build==1.2.2.post1 ; python_version >= "3.9"
 colorama==0.4.6 ; python_version >= "3.9" and os_name == "nt"
-importlib-metadata==8.6.1 ; python_version >= "3.9" and python_full_version < "3.10.2"
-packaging==24.2 ; python_version >= "3.9"
-pip==25.0.1 ; python_version >= "3.9"
+importlib-metadata==8.7.0 ; python_version >= "3.9" and python_full_version < "3.10.2"
+packaging==25.0 ; python_version >= "3.9"
+pip==25.1.1 ; python_version >= "3.9"
 pyproject-hooks==1.2.0 ; python_version >= "3.9"
 tomli==2.2.1 ; python_version >= "3.9" and python_version < "3.11"
 zipp==3.21.0 ; python_version >= "3.9" and python_full_version < "3.10.2"
diff --git a/requirements/test/requirements.txt b/requirements/test/requirements.txt
@@ -1,11 +1,12 @@
 colorama==0.4.6 ; python_version >= "3.9" and sys_platform == "win32"
-coverage==7.7.0 ; python_version >= "3.9"
-exceptiongroup==1.2.2 ; python_version >= "3.9" and python_version < "3.11"
-importlib-metadata==8.6.1 ; python_version == "3.9"
-iniconfig==2.0.0 ; python_version >= "3.9"
-packaging==24.2 ; python_version >= "3.9"
+coverage==7.8.0 ; python_version >= "3.9"
+exceptiongroup==1.3.0 ; python_version >= "3.9" and python_version < "3.11"
+importlib-metadata==8.7.0 ; python_version == "3.9"
+iniconfig==2.1.0 ; python_version >= "3.9"
+packaging==25.0 ; python_version >= "3.9"
 pluggy==1.5.0 ; python_version >= "3.9"
 pytest-randomly==3.16.0 ; python_version >= "3.9"
 pytest==8.3.5 ; python_version >= "3.9"
 tomli==2.2.1 ; python_version >= "3.9" and python_full_version <= "3.11.0a6"
+typing-extensions==4.13.2 ; python_version >= "3.9" and python_version < "3.11"
 zipp==3.21.0 ; python_version == "3.9"
diff --git a/src/sqliteimport/accessor.py b/src/sqliteimport/accessor.py
@@ -11,6 +11,7 @@
 import typing
 
 from .compat import marshal
+from .errors import FileNotFoundInDatabaseError
 from .util import get_magic_number, get_python_identifier
 
 
@@ -238,25 +239,32 @@ def get_file(
     ) -> bytes:
         contents: bytes
         if path:
-            contents = self.connection.execute(
+            cursor = self.connection.execute(
                 """
                 SELECT
                     contents
                 FROM code
                 WHERE path LIKE ?;
                 """,
                 (path,),
-            ).fetchone()[0]
+            )
         else:  # fullname
-            contents = self.connection.execute(
+            cursor = self.connection.execute(
                 """
                 SELECT
                     contents
                 FROM code
                 WHERE fullname LIKE ?;
                 """,
                 (fullname,),
-            ).fetchone()[0]
+            )
+
+        try:
+            contents = cursor.fetchone()[0]
+        except TypeError:
+            filename = str(path or fullname)
+            database_path = self.get_database_path(self.connection)
+            raise FileNotFoundInDatabaseError(filename, database_path)
 
         return decompress(contents)
 
diff --git a/src/sqliteimport/cli.py b/src/sqliteimport/cli.py
@@ -8,27 +8,25 @@
 import sys
 import textwrap
 
-import prettytable
-
 from . import bundler, compiler
 from .accessor import Accessor
 from .util import get_magic_number
 
 try:
     import click
+    import prettytable
 except ImportError:
-    print(
-        textwrap.dedent(
-            """
-            sqliteimport is not installed with CLI support.
-
-            This is typically resolved by adding '[cli]' to the end of the package name
-            when installing sqliteimport. For example:
-
-                python -m pip install sqliteimport[cli]
-            """
-        )
-    )
+    message = """
+        sqliteimport is not installed with CLI support.
+
+        This is typically resolved by adding '[cli]' to the end of the package name
+        when installing sqliteimport. Example commands that may resolve this:
+
+        *   python -m pip install sqliteimport[cli]
+        *   pipx install sqliteimport[cli]
+    """
+
+    print(textwrap.dedent(message), file=sys.stderr)
     sys.exit(2)
 
 
diff --git a/src/sqliteimport/errors.py b/src/sqliteimport/errors.py
@@ -0,0 +1,9 @@
+class SqliteImportError(Exception):
+    pass
+
+
+class FileNotFoundInDatabaseError(SqliteImportError, FileNotFoundError):
+    def __init__(self, filename: str, database_path: str) -> None:
+        super().__init__(
+            2, "File not found in database", filename, None, database_path or ":memory:"
+        )
diff --git a/src/sqliteimport/importer.py b/src/sqliteimport/importer.py
@@ -76,7 +76,7 @@ def find_distributions(
         # This try/except block is an inelegant conditional.
         try:
             self.accessor.get_file(path=f"{context.name}-%.dist-info/METADATA")
-        except TypeError:
+        except FileNotFoundError:
             return
 
         yield SqliteDistribution(context.name, self.connection)
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,3 +1,4 @@
+import contextlib
 import pathlib
 import sqlite3
 import sys
@@ -21,3 +22,21 @@ def database():
         sqliteimport.load(connection)
 
         yield connection
+
+
+@pytest.fixture(scope="session")
+def ignore_tempermental_deprecations():
+    # Between 3.11 and 3.12.9, Python would throw DeprecationWarning when calling
+    # `importlib.resources.read_text()` and `importlib.resources.read_bytes()`.
+    # These are caught, confirmed to match expectations, and wholly ignored.
+    ignore_tempermental_warnings = contextlib.nullcontext()
+    if (3, 11) < sys.version_info[:3] <= (3, 12, 9):
+        ignore_tempermental_warnings = pytest.warns(
+            DeprecationWarning,
+            match=(
+                r"(open_text|read_text|read_binary) is deprecated. "
+                r"Use files\(\) instead"
+            ),
+        )
+
+    return ignore_tempermental_warnings
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -0,0 +1,9 @@
+import pytest
+
+
+def test_output_when_missing_cli_dependencies(capsys):
+    with pytest.raises(SystemExit):
+        import sqliteimport.cli  # noqa: F401  # imported by unused
+
+    _, stderr = capsys.readouterr()
+    assert "sqliteimport is not installed with CLI support" in stderr
diff --git a/tests/test_importing.py b/tests/test_importing.py
