sqlite-utils 3.37__tar.gz → 3.38a0__tar.gz

{sqlite_utils-3.37/sqlite_utils.egg-info → sqlite_utils-3.38a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlite-utils
-Version: 3.37
+Version: 3.38a0
 Summary: CLI tool and Python library for manipulating SQLite databases
 Home-page: https://github.com/simonw/sqlite-utils
 Author: Simon Willison

{sqlite_utils-3.37 → sqlite_utils-3.38a0}/docs/cli.rst

@@ -2084,7 +2084,7 @@ Every option for this table (with the exception of ``--pk-none``) can be specifi
 ``--drop-foreign-key column``
     Drop the specified foreign key.
 
-``--add-foregn-key column other_table other_column``
+``--add-foreign-key column other_table other_column``
     Add a foreign key constraint to ``column`` pointing to ``other_table.other_column``.
 
 If you want to see the SQL that will be executed to make the change without actually executing it, add the ``--sql`` flag. For example:

{sqlite_utils-3.37 → sqlite_utils-3.38a0}/docs/plugins.rst

@@ -115,6 +115,26 @@ Example implementation:
             "Say hello world"
             click.echo("Hello world!")
 
+New commands implemented by plugins can invoke existing commands using the `context.invoke <https://click.palletsprojects.com/en/stable/api/#click.Context.invoke>`__ mechanism.
+
+As a special niche feature, if your plugin needs to import some files and then act against an in-memory database containing those files you can forward to the :ref:`sqlite-utils memory command <cli_memory>` and pass it ``return_db=True``:
+
+.. code-block:: python
+
+    @cli.command()
+    @click.pass_context
+    @click.argument(
+        "paths",
+        type=click.Path(file_okay=True, dir_okay=False, allow_dash=True),
+        required=False,
+        nargs=-1,
+    )
+    def show_schema_for_files(ctx, paths):
+        from sqlite_utils.cli import memory
+        db = ctx.invoke(memory, paths=paths, return_db=True)
+        # Now do something with that database
+        click.echo(db.schema)
+
 .. _plugins_hooks_prepare_connection:
 
 prepare_connection(conn)

{sqlite_utils-3.37 → sqlite_utils-3.38a0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 import io
 import os
 
-VERSION = "3.37"
+VERSION = "3.38a0"
 
 
 def get_long_description():

{sqlite_utils-3.37 → sqlite_utils-3.38a0}/sqlite_utils/cli.py

@@ -1894,6 +1894,7 @@ def memory(
     save,
     analyze,
     load_extension,
+    return_db=False,
 ):
     """Execute SQL query against an in-memory database, optionally populated by imported data
 
@@ -1922,6 +1923,7 @@ def memory(
         sqlite-utils memory animals.csv --schema
     """
     db = sqlite_utils.Database(memory=True)
+
     # If --dump or --save or --analyze used but no paths detected, assume SQL query is a path:
     if (dump or save or schema or analyze) and not paths:
         paths = [sql]
@@ -1954,6 +1956,7 @@ def memory(
             rows = tracker.wrap(rows)
         if flatten:
             rows = (_flatten(row) for row in rows)
+
         db[file_table].insert_all(rows, alter=True)
         if tracker is not None:
             db[file_table].transform(types=tracker.types)
@@ -1964,6 +1967,7 @@ def memory(
         for view_name in view_names:
             if not db[view_name].exists():
                 db.create_view(view_name, "select * from [{}]".format(file_table))
+
         if fp:
             fp.close()
 
@@ -1994,6 +1998,9 @@ def memory(
     if functions:
         _register_functions(db, functions)
 
+    if return_db:
+        return db
+
     _execute_query(
         db,
         sql,

{sqlite_utils-3.37 → sqlite_utils-3.38a0}/sqlite_utils/db.py

@@ -325,6 +325,8 @@ class Database:
         execute_plugins: bool = True,
         strict: bool = False,
     ):
+        self.memory_name = None
+        self.memory = False
         assert (filename_or_conn is not None and (not memory and not memory_name)) or (
             filename_or_conn is None and (memory or memory_name)
         ), "Either specify a filename_or_conn or pass memory=True"
@@ -335,8 +337,11 @@ class Database:
                 uri=True,
                 check_same_thread=False,
             )
+            self.memory = True
+            self.memory_name = memory_name
         elif memory or filename_or_conn == ":memory:":
             self.conn = sqlite3.connect(":memory:")
+            self.memory = True
         elif isinstance(filename_or_conn, (str, pathlib.Path)):
             if recreate and os.path.exists(filename_or_conn):
                 try:

{sqlite_utils-3.37 → sqlite_utils-3.38a0/sqlite_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlite-utils
-Version: 3.37
+Version: 3.38a0
 Summary: CLI tool and Python library for manipulating SQLite databases
 Home-page: https://github.com/simonw/sqlite-utils
 Author: Simon Willison

{sqlite_utils-3.37 → sqlite_utils-3.38a0}/tests/test_cli_memory.py

@@ -1,5 +1,5 @@
+import click
 import json
-
 import pytest
 from click.testing import CliRunner
 
@@ -305,3 +305,16 @@ def test_memory_functions():
     )
     assert result.exit_code == 0
     assert result.output.strip() == '[{"hello()": "Hello"}]'
+
+
+def test_memory_return_db(tmpdir):
+    # https://github.com/simonw/sqlite-utils/issues/643
+    from sqlite_utils.cli import cli
+
+    path = str(tmpdir / "dogs.csv")
+    open(path, "w").write("id,name\n1,Cleo")
+
+    with click.Context(cli) as ctx:
+        db = ctx.invoke(cli.commands["memory"], paths=(path,), return_db=True)
+
+    assert db.table_names() == ["dogs"]