cardinal-pythonlib 2.0.2__tar.gz → 2.0.4__tar.gz

{cardinal_pythonlib-2.0.2 → cardinal_pythonlib-2.0.4}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: cardinal_pythonlib
-Version: 2.0.2
+Version: 2.0.4
 Summary: Miscellaneous Python libraries
 Home-page: https://github.com/RudolfCardinal/pythonlib
 Author: Rudolf Cardinal
 Author-email: rudolf@pobox.com
 License: Apache License 2.0
 Keywords: cardinal
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -43,5 +42,3 @@ By Rudolf Cardinal (rudolf@pobox.com)
 Install with ``pip install cardinal_pythonlib``.
 
 Documentation is at https://cardinalpythonlib.readthedocs.io/.
-
-

{cardinal_pythonlib-2.0.2 → cardinal_pythonlib-2.0.4}/cardinal_pythonlib/sql/validation.py

@@ -212,6 +212,7 @@ SQLTYPES_DATETIME_ALL = SQLTYPES_WITH_DATE + SQLTYPES_DATETIME_OTHER
 SQLTYPES_ALL = (
     SQLTYPES_INTEGER
     + SQLTYPES_FLOAT
+    + SQLTYPES_BIT
     + SQLTYPES_OTHER_NUMERIC
     + SQLTYPES_TEXT
     + SQLTYPES_BINARY
@@ -221,11 +222,14 @@ SQLTYPES_ALL = (
 SQLTYPES_NOT_TEXT = (
     SQLTYPES_INTEGER
     + SQLTYPES_FLOAT
+    + SQLTYPES_BIT
     + SQLTYPES_OTHER_NUMERIC
     + SQLTYPES_DATETIME_ALL
     + SQLTYPES_OTHER
 )
-SQLTYPES_NUMERIC = SQLTYPES_INTEGER + SQLTYPES_FLOAT + SQLTYPES_OTHER_NUMERIC
+SQLTYPES_NUMERIC = (
+    SQLTYPES_INTEGER + SQLTYPES_FLOAT + SQLTYPES_BIT + SQLTYPES_OTHER_NUMERIC
+)
 
 
 # =============================================================================

{cardinal_pythonlib-2.0.2 → cardinal_pythonlib-2.0.4}/cardinal_pythonlib/sqlalchemy/alembic_func.py

@@ -26,22 +26,22 @@
 
 """
 
+import logging
 import os
 import re
-import subprocess
 from typing import Tuple
 
-from alembic.config import Config
-from alembic.util.exc import CommandError
+from alembic.command import revision as mk_revision
+from alembic.config import CommandLine, Config as AlembicConfig
 from alembic.runtime.migration import MigrationContext
 from alembic.runtime.environment import EnvironmentContext
 from alembic.script import ScriptDirectory
+from alembic.util.exc import CommandError
 from sqlalchemy.engine import create_engine
 
 from cardinal_pythonlib.fileops import preserve_cwd
-from cardinal_pythonlib.logs import get_brace_style_log_with_null_handler
 
-log = get_brace_style_log_with_null_handler(__name__)
+log = logging.getLogger(__name__)
 
 
 # =============================================================================
@@ -80,7 +80,7 @@ def get_head_revision_from_alembic(
 
     Arguments:
         alembic_config_filename:
-            config filename
+            config filename (usually a full path to an alembic.ini file)
         alembic_base_dir:
             directory to start in, so relative paths in the config file work.
         version_table:
@@ -89,9 +89,9 @@ def get_head_revision_from_alembic(
     if alembic_base_dir is None:
         alembic_base_dir = os.path.dirname(alembic_config_filename)
     os.chdir(alembic_base_dir)  # so the directory in the config file works
-    config = Config(alembic_config_filename)
-    script = ScriptDirectory.from_config(config)
-    with EnvironmentContext(config, script, version_table=version_table):
+    alembic_cfg = AlembicConfig(alembic_config_filename)
+    script = ScriptDirectory.from_config(alembic_cfg)
+    with EnvironmentContext(alembic_cfg, script, version_table=version_table):
         return script.get_current_head()
 
 
@@ -123,11 +123,14 @@ def get_current_and_head_revision(
     :func:`get_current_revision` and :func:`get_head_revision_from_alembic`.
 
     Arguments:
-        database_url: SQLAlchemy URL for the database
-        alembic_config_filename: config filename
-        alembic_base_dir: directory to start in, so relative paths in the
-            config file work.
-        version_table: table name for Alembic versions
+        database_url:
+            SQLAlchemy URL for the database
+        alembic_config_filename:
+            config filename (usually a full path to an alembic.ini file)
+        alembic_base_dir:
+            directory to start in, so relative paths in the config file work.
+        version_table:
+            table name for Alembic versions
     """
     # Where we are
     head_revision = get_head_revision_from_alembic(
@@ -135,13 +138,13 @@ def get_current_and_head_revision(
         alembic_base_dir=alembic_base_dir,
         version_table=version_table,
     )
-    log.debug("Intended database version: {}", head_revision)
+    log.debug(f"Intended database version: {head_revision}")
 
     # Where we want to be
     current_revision = get_current_revision(
         database_url=database_url, version_table=version_table
     )
-    log.debug("Current database version: {}", current_revision)
+    log.debug(f"Current database version: {current_revision}")
 
     # Are we where we want to be?
     return current_revision, head_revision
@@ -165,49 +168,43 @@ def upgrade_database(
 
     Arguments:
         alembic_config_filename:
-            config filename
-
+            config filename (usually a full path to an alembic.ini file)
         db_url:
             Optional database URL to use, by way of override.
-
         alembic_base_dir:
             directory to start in, so relative paths in the config file work
-
         starting_revision:
             revision to start at (typically ``None`` to ask the database)
-
         destination_revision:
             revision to aim for (typically ``"head"`` to migrate to the latest
             structure)
-
-        version_table: table name for Alembic versions
-
+        version_table:
+            table name for Alembic versions
         as_sql:
             run in "offline" mode: print the migration SQL, rather than
             modifying the database. See
             https://alembic.zzzcomputing.com/en/latest/offline.html
-
     """
 
     if alembic_base_dir is None:
         alembic_base_dir = os.path.dirname(alembic_config_filename)
     os.chdir(alembic_base_dir)  # so the directory in the config file works
-    config = Config(alembic_config_filename)
+    alembic_cfg = AlembicConfig(alembic_config_filename)
     if db_url:
-        config.set_main_option("sqlalchemy.url", db_url)
-    script = ScriptDirectory.from_config(config)
+        alembic_cfg.set_main_option("sqlalchemy.url", db_url)
+    script = ScriptDirectory.from_config(alembic_cfg)
 
     # noinspection PyUnusedLocal,PyProtectedMember
     def upgrade(rev, context):
         return script._upgrade_revs(destination_revision, rev)
 
     log.info(
-        "Upgrading database to revision {!r} using Alembic",
-        destination_revision,
+        f"Upgrading database to revision {destination_revision!r} "
+        f"using Alembic"
     )
 
     with EnvironmentContext(
-        config,
+        alembic_cfg,
         script,
         fn=upgrade,
         as_sql=as_sql,
@@ -240,48 +237,42 @@ def downgrade_database(
 
     Arguments:
         alembic_config_filename:
-            config filename
-
+            config filename (usually a full path to an alembic.ini file)
         db_url:
             Optional database URL to use, by way of override.
-
         alembic_base_dir:
             directory to start in, so relative paths in the config file work
-
         starting_revision:
             revision to start at (typically ``None`` to ask the database)
-
         destination_revision:
             revision to aim for
-
-        version_table: table name for Alembic versions
-
+        version_table:
+            table name for Alembic versions
         as_sql:
             run in "offline" mode: print the migration SQL, rather than
             modifying the database. See
             https://alembic.zzzcomputing.com/en/latest/offline.html
-
     """
 
     if alembic_base_dir is None:
         alembic_base_dir = os.path.dirname(alembic_config_filename)
     os.chdir(alembic_base_dir)  # so the directory in the config file works
-    config = Config(alembic_config_filename)
+    alembic_cfg = AlembicConfig(alembic_config_filename)
     if db_url:
-        config.set_main_option("sqlalchemy.url", db_url)
-    script = ScriptDirectory.from_config(config)
+        alembic_cfg.set_main_option("sqlalchemy.url", db_url)
+    script = ScriptDirectory.from_config(alembic_cfg)
 
     # noinspection PyUnusedLocal,PyProtectedMember
     def downgrade(rev, context):
         return script._downgrade_revs(destination_revision, rev)
 
     log.info(
-        "Downgrading database to revision {!r} using Alembic",
-        destination_revision,
+        f"Downgrading database to revision {destination_revision!r} "
+        f"using Alembic"
     )
 
     with EnvironmentContext(
-        config,
+        alembic_cfg,
         script,
         fn=downgrade,
         as_sql=as_sql,
@@ -301,6 +292,7 @@ def create_database_migration_numbered_style(
     alembic_versions_dir: str,
     message: str,
     n_sequence_chars: int = 4,
+    db_url: str = None,
 ) -> None:
     """
      Create a new Alembic migration script.
@@ -331,26 +323,34 @@ def create_database_migration_numbered_style(
 
     See https://alembic.zzzcomputing.com/en/latest/autogenerate.html.
 
-     Regarding filenames: the default ``n_sequence_chars`` of 4 is like Django
-     and gives files with names like
+    Regarding filenames: the default ``n_sequence_chars`` of 4 is like Django
+    and gives files with names like
 
-     .. code-block:: none
+    .. code-block:: none
 
-         0001_x.py, 0002_y.py, ...
+        0001_x.py, 0002_y.py, ...
 
-     NOTE THAT TO USE A NON-STANDARD ALEMBIC VERSION TABLE, YOU MUST SPECIFY
-     THAT IN YOUR ``env.py`` (see e.g. CamCOPS).
+    NOTE THAT TO USE A NON-STANDARD ALEMBIC VERSION TABLE, YOU MUST SPECIFY
+    THAT IN YOUR ``env.py`` (see e.g. CamCOPS).
 
-     Args:
-         alembic_ini_file: filename of Alembic ``alembic.ini`` file
-         alembic_versions_dir: directory in which you keep your Python scripts,
-             one per Alembic revision
-         message: message to be associated with this revision
-         n_sequence_chars: number of numerical sequence characters to use in the
-             filename/revision (see above).
+    Args:
+        alembic_ini_file:
+            filename (full path) of Alembic ``alembic.ini`` file
+        alembic_versions_dir:
+            directory in which you keep your Python scripts, one per Alembic
+            revision
+        message:
+            message to be associated with this revision
+        n_sequence_chars:
+            number of numerical sequence characters to use in the
+            filename/revision (see above).
+        db_url:
+            Optional database URL to use, by way of override. We achieve this
+            via a temporary config file; not ideal.
     """  # noqa: E501
-    file_regex = r"\d{" + str(n_sequence_chars) + r"}_\S*\.py$"
 
+    # Calculate current_seq_str, new_seq_str:
+    file_regex = r"\d{" + str(n_sequence_chars) + r"}_\S*\.py$"
     _, _, existing_version_filenames = next(
         os.walk(alembic_versions_dir), (None, None, [])
     )
@@ -358,8 +358,8 @@ def create_database_migration_numbered_style(
         x for x in existing_version_filenames if re.match(file_regex, x)
     ]
     log.debug(
-        "Existing Alembic version script filenames: {!r}",
-        existing_version_filenames,
+        f"Existing Alembic version script filenames: "
+        f"{existing_version_filenames!r}"
     )
     current_seq_strs = [
         x[:n_sequence_chars] for x in existing_version_filenames
@@ -374,37 +374,29 @@ def create_database_migration_numbered_style(
     new_seq_str = str(new_seq_no).zfill(n_sequence_chars)
 
     log.info(
-        """
-Generating new revision with Alembic...
-    Last revision was: {}
-    New revision will be: {}
-    [If it fails with "Can't locate revision identified by...", you might need
-    to DROP the Alembic version table (by default named 'alembic_version', but
-    you may have elected to change that in your env.py.]
-        """,
-        current_seq_str,
-        new_seq_str,
+        f"Generating new revision with Alembic. "
+        f"Last revision was: {current_seq_str}. "
+        f"New revision will be: {new_seq_str}. "
+        f"(If the process fails with \"Can't locate revision identified "
+        f'by...", you might need to DROP the Alembic version table; by '
+        f"default that is named {DEFAULT_ALEMBIC_VERSION_TABLE!r}, but you "
+        f"may have elected to change that in your 'env.py' file.)"
     )
 
     alembic_ini_dir = os.path.dirname(alembic_ini_file)
     os.chdir(alembic_ini_dir)
-    cmdargs = [
-        "alembic",
-        "-c",
-        alembic_ini_file,
-        "revision",
-        "--autogenerate",
-        "-m",
-        message,
-        "--rev-id",
-        new_seq_str,
-    ]
-    log.info("From directory {!r}, calling: {!r}", alembic_ini_dir, cmdargs)
-    subprocess.call(cmdargs)
+
+    # https://github.com/sqlalchemy/alembic/discussions/1089
+    namespace = CommandLine().parser.parse_args(["revision", "--autogenerate"])
+    config = AlembicConfig(alembic_ini_file, cmd_opts=namespace)
+    if db_url:
+        config.set_main_option("sqlalchemy.url", db_url)
+
+    mk_revision(config, message=message, autogenerate=True, rev_id=new_seq_str)
 
 
 def stamp_allowing_unusual_version_table(
-    config: Config,
+    config: AlembicConfig,
     revision: str,
     sql: bool = False,
     tag: str = None,

{cardinal_pythonlib-2.0.2 → cardinal_pythonlib-2.0.4}/cardinal_pythonlib/sqlalchemy/schema.py

@@ -417,8 +417,18 @@ def execute_ddl(
     if sql:
         ddl = DDL(sql)
     with engine.connect() as connection:
-        # DDL doesn't need a COMMIT.
         connection.execute(ddl)
+        # DDL may need a commit for some dialects:
+        #
+        # Generic (but generic may not be useful)
+        #     https://stackoverflow.com/questions/730621/do-ddl-statements-always-give-you-an-implicit-commit-or-can-you-get-an-implicit
+        # Oracle - autocommitted?
+        #     https://docs.oracle.com/cd/A97335_02/apps.102/a83723/keyprog6.htm
+        # but not Postgres?
+        #     https://dba.stackexchange.com/questions/340916/why-must-i-commit-after-the-alter-table-ddl-to-make-changes-visible
+        # and in SQL Server they are "batched" so not entirely autocommitted
+        #     https://www.mssqltips.com/sqlservertip/4591/ddl-commands-in-transactions-in-sql-server-versus-oracle/
+        connection.commit()
 
 
 # =============================================================================

{cardinal_pythonlib-2.0.2 → cardinal_pythonlib-2.0.4}/cardinal_pythonlib/version_string.py

@@ -31,5 +31,5 @@ For changelog, see changelog.rst
 
 """
 
-VERSION_STRING = "2.0.2"
+VERSION_STRING = "2.0.4"
 # Use semantic versioning: https://semver.org/

{cardinal_pythonlib-2.0.2 → cardinal_pythonlib-2.0.4}/cardinal_pythonlib.egg-info/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: cardinal-pythonlib
-Version: 2.0.2
+Version: 2.0.4
 Summary: Miscellaneous Python libraries
 Home-page: https://github.com/RudolfCardinal/pythonlib
 Author: Rudolf Cardinal
 Author-email: rudolf@pobox.com
 License: Apache License 2.0
 Keywords: cardinal
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -43,5 +42,3 @@ By Rudolf Cardinal (rudolf@pobox.com)
 Install with ``pip install cardinal_pythonlib``.
 
 Documentation is at https://cardinalpythonlib.readthedocs.io/.
-
-

{cardinal_pythonlib-2.0.2 → cardinal_pythonlib-2.0.4}/cardinal_pythonlib.egg-info/entry_points.txt

@@ -16,4 +16,3 @@ cardinalpythonlib_merge_csv = cardinal_pythonlib.tools.merge_csv:main
 cardinalpythonlib_pause_process_by_disk_space = cardinal_pythonlib.openxml.pause_process_by_disk_space:main
 cardinalpythonlib_pdf_to_booklet = cardinal_pythonlib.tools.pdf_to_booklet:main
 cardinalpythonlib_remove_duplicate_files = cardinal_pythonlib.tools.remove_duplicate_files:main
-

{cardinal_pythonlib-2.0.2 → cardinal_pythonlib-2.0.4}/cardinal_pythonlib.egg-info/requires.txt

@@ -1,4 +1,3 @@
-SQLAlchemy<3.0,>=1.4
 alembic
 appdirs>=1.4.0
 arrow>=0.15
@@ -10,8 +9,8 @@ numba
 numpy<2.0,>=1.20.0
 openpyxl
 pandas
-pdfminer.six>=20191010
 pendulum>=2.1.1
+pdfminer.six>=20191010
 prettytable
 psutil
 pygments
@@ -21,5 +20,6 @@ python-dateutil
 rich-argparse>=0.5.0
 scipy
 semantic-version
+SQLAlchemy<3.0,>=1.4
 sqlparse
 xlrd>=2.0.0