sqlite-utils 3.36__py3-none-any.whl → 3.38__py3-none-any.whl

sqlite_utils/cli.py

@@ -1489,7 +1489,7 @@ def create_database(path, enable_wal, init_spatialite, load_extension):
 )
 @click.argument("table")
 @click.argument("columns", nargs=-1, required=True)
-@click.option("--pk", help="Column to use as primary key")
+@click.option("pks", "--pk", help="Column to use as primary key", multiple=True)
 @click.option(
     "--not-null",
     multiple=True,
@@ -1532,7 +1532,7 @@ def create_table(
     path,
     table,
     columns,
-    pk,
+    pks,
     not_null,
     default,
     fk,
@@ -1581,7 +1581,7 @@ def create_table(
             )
     db[table].create(
         coltypes,
-        pk=pk,
+        pk=pks[0] if len(pks) == 1 else pks,
         not_null=not_null,
         defaults=dict(default),
         foreign_keys=fk,
@@ -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,
@@ -2594,7 +2601,7 @@ def extract(
     multiple=True,
     help="Column definitions for the table",
 )
-@click.option("--pk", type=str, help="Column to use as primary key")
+@click.option("pks", "--pk", help="Column to use as primary key", multiple=True)
 @click.option("--alter", is_flag=True, help="Alter table to add missing columns")
 @click.option("--replace", is_flag=True, help="Replace files with matching primary key")
 @click.option("--upsert", is_flag=True, help="Upsert files with matching primary key")
@@ -2611,7 +2618,7 @@ def insert_files(
     table,
     file_or_dir,
     column,
-    pk,
+    pks,
     alter,
     replace,
     upsert,
@@ -2641,8 +2648,8 @@ def insert_files(
             column = ["path:path", "content_text:content_text", "size:size"]
         else:
             column = ["path:path", "content:content", "size:size"]
-        if not pk:
-            pk = "path"
+        if not pks:
+            pks = ["path"]
 
     def yield_paths_and_relative_paths():
         for f_or_d in file_or_dir:
@@ -2712,7 +2719,11 @@ def insert_files(
         try:
             with db.conn:
                 db[table].insert_all(
-                    to_insert(), pk=pk, alter=alter, replace=replace, upsert=upsert
+                    to_insert(),
+                    pk=pks[0] if len(pks) == 1 else pks,
+                    alter=alter,
+                    replace=replace,
+                    upsert=upsert,
                 )
         except UnicodeDecodeErrorForPath as e:
             raise click.ClickException(
@@ -2871,9 +2882,9 @@ def _generate_convert_help():
     Convert columns using Python code you supply. For example:
 
     \b
-        sqlite-utils convert my.db mytable mycolumn \\
-            '"\\n".join(textwrap.wrap(value, 10))' \\
-            --import=textwrap
+    sqlite-utils convert my.db mytable mycolumn \\
+        '"\\n".join(textwrap.wrap(value, 10))' \\
+        --import=textwrap
 
     "value" is a variable with the column value to be converted.
 
@@ -2892,7 +2903,7 @@ def _generate_convert_help():
     for name in recipe_names:
         fn = getattr(recipes, name)
         help += "\n\nr.{}{}\n\n\b{}".format(
-            name, str(inspect.signature(fn)), fn.__doc__.rstrip()
+            name, str(inspect.signature(fn)), textwrap.dedent(fn.__doc__.rstrip())
         )
     help += "\n\n"
     help += textwrap.dedent(
@@ -2900,8 +2911,8 @@ def _generate_convert_help():
     You can use these recipes like so:
 
     \b
-        sqlite-utils convert my.db mytable mycolumn \\
-            'r.jsonsplit(value, delimiter=":")'
+    sqlite-utils convert my.db mytable mycolumn \\
+        'r.jsonsplit(value, delimiter=":")'
     """
     ).strip()
     return help

sqlite_utils/db.py

@@ -156,6 +156,10 @@ XIndexColumn = namedtuple(
 Trigger = namedtuple("Trigger", ("name", "table", "sql"))
 
 
+class TransformError(Exception):
+    pass
+
+
 ForeignKeyIndicator = Union[
     str,
     ForeignKey,
@@ -206,21 +210,25 @@ COLUMN_TYPE_MAPPING = {
 }
 # If numpy is available, add more types
 if np:
-    COLUMN_TYPE_MAPPING.update(
-        {
-            np.int8: "INTEGER",
-            np.int16: "INTEGER",
-            np.int32: "INTEGER",
-            np.int64: "INTEGER",
-            np.uint8: "INTEGER",
-            np.uint16: "INTEGER",
-            np.uint32: "INTEGER",
-            np.uint64: "INTEGER",
-            np.float16: "FLOAT",
-            np.float32: "FLOAT",
-            np.float64: "FLOAT",
-        }
-    )
+    try:
+        COLUMN_TYPE_MAPPING.update(
+            {
+                np.int8: "INTEGER",
+                np.int16: "INTEGER",
+                np.int32: "INTEGER",
+                np.int64: "INTEGER",
+                np.uint8: "INTEGER",
+                np.uint16: "INTEGER",
+                np.uint32: "INTEGER",
+                np.uint64: "INTEGER",
+                np.float16: "FLOAT",
+                np.float32: "FLOAT",
+                np.float64: "FLOAT",
+            }
+        )
+    except AttributeError:
+        # https://github.com/simonw/sqlite-utils/issues/632
+        pass
 
 # If pandas is available, add more types
 if pd:
@@ -321,6 +329,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"
@@ -331,8 +341,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:
@@ -457,8 +470,7 @@ class Database:
                         fn_name, arity, fn, **dict(kwargs, deterministic=True)
                     )
                     registered = True
-                except (sqlite3.NotSupportedError, TypeError):
-                    # TypeError is Python 3.7 "function takes at most 3 arguments"
+                except sqlite3.NotSupportedError:
                     pass
             if not registered:
                 self.conn.create_function(fn_name, arity, fn, **kwargs)
@@ -926,13 +938,18 @@ class Database:
                         other_column=foreign_keys_by_column[column_name].other_column,
                     )
                 )
+            column_type_str = COLUMN_TYPE_MAPPING[column_type]
+            # Special case for strict tables to map FLOAT to REAL
+            # Refs https://github.com/simonw/sqlite-utils/issues/644
+            if strict and column_type_str == "FLOAT":
+                column_type_str = "REAL"
             column_defs.append(
                 "   [{column_name}] {column_type}{column_extras}".format(
                     column_name=column_name,
-                    column_type=COLUMN_TYPE_MAPPING[column_type],
-                    column_extras=(" " + " ".join(column_extras))
-                    if column_extras
-                    else "",
+                    column_type=column_type_str,
+                    column_extras=(
+                        (" " + " ".join(column_extras)) if column_extras else ""
+                    ),
                 )
             )
         extra_pk = ""
@@ -1481,9 +1498,11 @@ class Table(Queryable):
     def __repr__(self) -> str:
         return "<Table {}{}>".format(
             self.name,
-            " (does not exist yet)"
-            if not self.exists()
-            else " ({})".format(", ".join(c.name for c in self.columns)),
+            (
+                " (does not exist yet)"
+                if not self.exists()
+                else " ({})".format(", ".join(c.name for c in self.columns))
+            ),
         )
 
     @property
@@ -1962,6 +1981,30 @@ class Table(Queryable):
         sqls.append(
             "ALTER TABLE [{}] RENAME TO [{}];".format(new_table_name, self.name)
         )
+        # Re-add existing indexes
+        for index in self.indexes:
+            if index.origin != "pk":
+                index_sql = self.db.execute(
+                    """SELECT sql FROM sqlite_master WHERE type = 'index' AND name = :index_name;""",
+                    {"index_name": index.name},
+                ).fetchall()[0][0]
+                if index_sql is None:
+                    raise TransformError(
+                        f"Index '{index.name}' on table '{self.name}' does not have a "
+                        "CREATE INDEX statement. You must manually drop this index prior to running this "
+                        "transformation and manually recreate the new index after running this transformation."
+                    )
+                if keep_table:
+                    sqls.append(f"DROP INDEX IF EXISTS [{index.name}];")
+                for col in index.columns:
+                    if col in rename.keys() or col in drop:
+                        raise TransformError(
+                            f"Index '{index.name}' column '{col}' is not in updated table '{self.name}'. "
+                            f"You must manually drop this index prior to running this transformation "
+                            f"and manually recreate the new index after running this transformation. "
+                            f"The original index sql statement is: `{index_sql}`. No changes have been applied to this table."
+                        )
+                sqls.append(index_sql)
         return sqls
 
     def extract(
@@ -2640,6 +2683,7 @@ class Table(Queryable):
         offset: Optional[int] = None,
         where: Optional[str] = None,
         where_args: Optional[Union[Iterable, dict]] = None,
+        include_rank: bool = False,
         quote: bool = False,
     ) -> Generator[dict, None, None]:
         """
@@ -2653,6 +2697,7 @@ class Table(Queryable):
         :param offset: Optional integer SQL offset.
         :param where: Extra SQL fragment for the WHERE clause
         :param where_args: Arguments to use for :param placeholders in the extra WHERE clause
+        :param include_rank: Select the search rank column in the final query
         :param quote: Apply quoting to disable any special characters in the search query
 
         See :ref:`python_api_fts_search`.
@@ -2672,6 +2717,7 @@ class Table(Queryable):
                 limit=limit,
                 offset=offset,
                 where=where,
+                include_rank=include_rank,
             ),
             args,
         )
@@ -2940,9 +2986,11 @@ class Table(Queryable):
                 value = jsonify_if_needed(
                     record.get(
                         key,
-                        None
-                        if key != hash_id
-                        else hash_record(record, hash_id_columns),
+                        (
+                            None
+                            if key != hash_id
+                            else hash_record(record, hash_id_columns)
+                        ),
                     )
                 )
                 if key in extracts:

sqlite_utils/utils.py

@@ -304,10 +304,7 @@ def rows_from_file(
         rows = rows_from_file(
             fp, format=Format.CSV, dialect=csv.excel_tab, encoding=encoding
         )[0]
-        return (
-            _extra_key_strategy(rows, ignore_extras, extras_key),
-            Format.TSV,
-        )
+        return _extra_key_strategy(rows, ignore_extras, extras_key), Format.TSV
     elif format is None:
         # Detect the format, then call this recursively
         buffered = io.BufferedReader(cast(io.RawIOBase, fp), buffer_size=4096)

{sqlite_utils-3.36.dist-info → sqlite_utils-3.38.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlite-utils
-Version: 3.36
+Version: 3.38
 Summary: CLI tool and Python library for manipulating SQLite databases
 Home-page: https://github.com/simonw/sqlite-utils
 Author: Simon Willison
@@ -16,44 +16,44 @@ Classifier: Intended Audience :: Science/Research
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Topic :: Database
 Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.7
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: sqlite-fts4
 Requires-Dist: click
-Requires-Dist: click-default-group >=1.2.3
+Requires-Dist: click-default-group>=1.2.3
 Requires-Dist: tabulate
 Requires-Dist: python-dateutil
 Requires-Dist: pluggy
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: black>=24.1.1; extra == "test"
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: cogapp; extra == "test"
 Provides-Extra: docs
-Requires-Dist: furo ; extra == 'docs'
-Requires-Dist: sphinx-autobuild ; extra == 'docs'
-Requires-Dist: codespell ; extra == 'docs'
-Requires-Dist: sphinx-copybutton ; extra == 'docs'
-Requires-Dist: beanbag-docutils >=2.0 ; extra == 'docs'
-Requires-Dist: pygments-csv-lexer ; extra == 'docs'
-Provides-Extra: flake8
-Requires-Dist: flake8 ; extra == 'flake8'
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx-autobuild; extra == "docs"
+Requires-Dist: codespell; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: beanbag-docutils>=2.0; extra == "docs"
+Requires-Dist: pygments-csv-lexer; extra == "docs"
 Provides-Extra: mypy
-Requires-Dist: mypy ; extra == 'mypy'
-Requires-Dist: types-click ; extra == 'mypy'
-Requires-Dist: types-tabulate ; extra == 'mypy'
-Requires-Dist: types-python-dateutil ; extra == 'mypy'
-Requires-Dist: types-pluggy ; extra == 'mypy'
-Requires-Dist: data-science-types ; extra == 'mypy'
-Provides-Extra: test
-Requires-Dist: pytest ; extra == 'test'
-Requires-Dist: black ; extra == 'test'
-Requires-Dist: hypothesis ; extra == 'test'
-Requires-Dist: cogapp ; extra == 'test'
+Requires-Dist: mypy; extra == "mypy"
+Requires-Dist: types-click; extra == "mypy"
+Requires-Dist: types-tabulate; extra == "mypy"
+Requires-Dist: types-python-dateutil; extra == "mypy"
+Requires-Dist: types-pluggy; extra == "mypy"
+Requires-Dist: data-science-types; extra == "mypy"
+Provides-Extra: flake8
+Requires-Dist: flake8; extra == "flake8"
 Provides-Extra: tui
-Requires-Dist: trogon ; extra == 'tui'
+Requires-Dist: trogon; extra == "tui"
 
 # sqlite-utils
 

sqlite_utils-3.38.dist-info/RECORD

@@ -0,0 +1,15 @@
+sqlite_utils/__init__.py,sha256=eyDK-5KOo-ARS3i0JcuxGiJmk5T-58Z1p_bhACbBrGc,201
+sqlite_utils/__main__.py,sha256=8hDtWlaFZK24KhfNq_ZKgtXqYHsDQDetukOCMlsbW0Q,59
+sqlite_utils/cli.py,sha256=r1cQ70T1KE-0va-ob-AC76Rr81SaSeEVOKp3FAbyPHM,89832
+sqlite_utils/db.py,sha256=6minoeWeXkdVS7XwFUUPymePwYtOokwrVIn0qZ1HiI0,148509
+sqlite_utils/hookspecs.py,sha256=NFA0BFZ8WUhnI_NRz4oFVDcomQYlguuAgUCBKAN792o,395
+sqlite_utils/plugins.py,sha256=V5nXD4r0o1wSbIHHOAiUBBV66ZOfKVnywKfZzCUqdsA,771
+sqlite_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sqlite_utils/recipes.py,sha256=_npzti0nPV6XxvMj69Ca4QF-pXwZZQp_f_VY3i7pQDs,1687
+sqlite_utils/utils.py,sha256=PRqoITtqmaUI7xzyB2exaTPg6oXbTMhGDzld7srNOG4,17099
+sqlite_utils-3.38.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+sqlite_utils-3.38.dist-info/METADATA,sha256=12ik5_GloHZ2sO5GCbvFjzQVU1NG_zubIMPfF6V35k4,7540
+sqlite_utils-3.38.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+sqlite_utils-3.38.dist-info/entry_points.txt,sha256=33jbVHROlRBNhoXoSI-QI2rN6JDkJIkKIX7P5sNIWdY,54
+sqlite_utils-3.38.dist-info/top_level.txt,sha256=_dw_n5BWKUEtCYB2DTlmPMQfdRZSuFsmRQe2ZhNYwnQ,13
+sqlite_utils-3.38.dist-info/RECORD,,

{sqlite_utils-3.36.dist-info → sqlite_utils-3.38.dist-info}/WHEEL

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

sqlite_utils-3.36.dist-info/RECORD

@@ -1,15 +0,0 @@
-sqlite_utils/__init__.py,sha256=eyDK-5KOo-ARS3i0JcuxGiJmk5T-58Z1p_bhACbBrGc,201
-sqlite_utils/__main__.py,sha256=8hDtWlaFZK24KhfNq_ZKgtXqYHsDQDetukOCMlsbW0Q,59
-sqlite_utils/cli.py,sha256=C69OYAbz5Tu_PK8-Rtkuu8UhpJZpCztLkiG2orkNhUU,89593
-sqlite_utils/db.py,sha256=rXIeGnA3TM6QvjpvQE5p4oHV79dKfa7hch2eJ1fJTHA,146180
-sqlite_utils/hookspecs.py,sha256=NFA0BFZ8WUhnI_NRz4oFVDcomQYlguuAgUCBKAN792o,395
-sqlite_utils/plugins.py,sha256=V5nXD4r0o1wSbIHHOAiUBBV66ZOfKVnywKfZzCUqdsA,771
-sqlite_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sqlite_utils/recipes.py,sha256=_npzti0nPV6XxvMj69Ca4QF-pXwZZQp_f_VY3i7pQDs,1687
-sqlite_utils/utils.py,sha256=jvlsGQ5F_Z7-bAiP7gw4hmov_58PrVMvY_5UZ3nXfAg,17136
-sqlite_utils-3.36.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-sqlite_utils-3.36.dist-info/METADATA,sha256=kcoJW64Z6uM0yyzjyaKrdxM21ev9EEbHmrMORB5m3TA,7551
-sqlite_utils-3.36.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-sqlite_utils-3.36.dist-info/entry_points.txt,sha256=33jbVHROlRBNhoXoSI-QI2rN6JDkJIkKIX7P5sNIWdY,54
-sqlite_utils-3.36.dist-info/top_level.txt,sha256=_dw_n5BWKUEtCYB2DTlmPMQfdRZSuFsmRQe2ZhNYwnQ,13
-sqlite_utils-3.36.dist-info/RECORD,,