Merge pull request #87 from kurtmckee/fix-find_distributions-lacking-a-name

Find all available distributions when no name is given

Author: kurtmckee

changelog.d/20250515_073520_kurtmckee_fix_find_distributions_lacking_a_name.rst

@@ -0,0 +1,6 @@
+Fixed
+-----
+
+*   Find all available distributions when no name is given.
+
+    This allows tools like flake8 to auto-detect installed plugins.

src/sqliteimport/accessor.py

@@ -268,6 +268,35 @@ def get_file(
 
         return decompress(contents)
 
+    def find_distributions(self, name: str | None) -> typing.Generator[str]:
+        if name is not None:
+            path_pattern = f"{name}-%.dist-info/METADATA"
+        else:
+            path_pattern = "%.dist-info/METADATA"
+
+        sql = """
+            SELECT
+                path
+            FROM code
+            WHERE
+                path LIKE $path_pattern
+            ;
+        """
+
+        cursor = self.connection.execute(
+            sql,
+            {"path_pattern": path_pattern},
+        )
+        rows = cursor.fetchall()
+        if rows is None:
+            return
+
+        path: str
+        for (path,) in rows:
+            module, _, _ = path.partition("-")
+            if module.isidentifier():
+                yield module
+
     def list_directory(self, path_like: str) -> list[str]:
         """List the contents of a directory."""
 

src/sqliteimport/importer.py

@@ -24,7 +24,7 @@
 )
 
 
-class SqliteFinder(importlib.abc.MetaPathFinder):
+class SqliteFinder(importlib.metadata.DistributionFinder):
     def __init__(self, database: pathlib.Path | sqlite3.Connection) -> None:
         if isinstance(database, pathlib.Path):
             self.database = database
@@ -69,17 +69,9 @@ def find_distributions(
     ) -> typing.Generator[SqliteDistribution]:
         if context is None:
             context = importlib.metadata.DistributionFinder.Context()
-        if context.name is None:
-            return
 
-        # Determine if the distribution exists.
-        # This try/except block is an inelegant conditional.
-        try:
-            self.accessor.get_file(path=f"{context.name}-%.dist-info/METADATA")
-        except FileNotFoundError:
-            return
-
-        yield SqliteDistribution(context.name, self.connection)
+        for module in self.accessor.find_distributions(context.name):
+            yield SqliteDistribution(module, self.connection)
 
 
 @accommodate_python_39_from_package_behavior
@@ -114,6 +106,12 @@ def __init__(self, name: str, connection: sqlite3.Connection) -> None:
         self.__connection = connection
         self.__accessor = Accessor(connection)
 
+    if sys.version_info < (3, 10):
+        # The `.name` property doesn't exist in Python 3.9.
+        @property
+        def name(self) -> str:
+            return self.metadata["Name"]
+
     def locate_file(self, path: typing.Any) -> pathlib.Path:
         raise NotImplementedError()
 

tests/test_importing.py

@@ -1,6 +1,7 @@
 import importlib.machinery
 import importlib.metadata
 import importlib.resources
+import importlib.util
 import sys
 import types
 import uuid
@@ -220,3 +221,27 @@ def test_distribution_finding(database):
     name = f"p{uuid.uuid4().hex}"
     discovered = list(sqliteimport.importer.SqliteDistribution.discover(name=name))
     assert discovered == []
+
+
+def test_find_distributions_finds_nothing(database):
+    name = f"p{uuid.uuid4().hex}"
+    distributions = list(importlib.metadata.distributions(name=name))
+    assert distributions == []
+
+
+@pytest.mark.parametrize("name", ("package_filesystem", "package_sqlite"))
+def test_find_distributions_one_name(database, name, ignore_tempermental_deprecations):
+    distributions = list(importlib.metadata.distributions(name=name))
+    assert len(distributions) == 1
+    assert distributions[0].metadata["Name"] == name.replace("_", "-")
+
+
+def test_find_distributions_finds_everything(database):
+    distributions = list(importlib.metadata.distributions())
+    distribution_names = {d.metadata["Name"] for d in distributions}
+    expected_names = {
+        "module-sqlite",
+        "namespace-sqlite-plugin",
+        "package-sqlite",
+    }
+    assert distribution_names & expected_names == expected_names