Merge pull request #2 from dorosch/develop

Release 0.3.1

Author: dorosch

.github/workflows/tests.yml

@@ -35,6 +35,7 @@ jobs:
             pip install ".[test]"
 
       - name: Build coverage file
+        working-directory: ./tests
         run: |
           pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=sqlalchemy_timescaledb
 

.gitignore

@@ -43,3 +43,6 @@ docs/_build/
 
 # PyCharm
 .idea/
+
+# Alembic
+tests/migrations/versions/*

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sqlalchemy-timescaledb"
-version = "0.3"
+version = "0.3.1"
 authors = [
   { name="Andrei Kliatsko", email="andrey.daraschenka@gmail.com" },
 ]
@@ -16,7 +16,8 @@ test = [
     "pytest-cov==4.0.0",
     "pytest-factoryboy==2.5.1",
     "sqlalchemy>=1.3",
-    "psycopg2-binary==2.9.5"
+    "psycopg2-binary==2.9.5",
+    "alembic==1.9.4"
 ]
 
 [project.urls]

sqlalchemy_timescaledb/__init__.py

@@ -0,0 +1,18 @@
+from sqlalchemy.dialects import registry
+
+
+registry.register(
+    'timescaledb',
+    'sqlalchemy_timescaledb.dialect',
+    'TimescaledbPsycopg2Dialect'
+)
+registry.register(
+    'timescaledb.psycopg2',
+    'sqlalchemy_timescaledb.dialect',
+    'TimescaledbPsycopg2Dialect'
+)
+registry.register(
+    'timescaledb.asyncpg',
+    'sqlalchemy_timescaledb.dialect',
+    'TimescaledbAsyncpgDialect'
+)

sqlalchemy_timescaledb/dialect.py

@@ -3,6 +3,16 @@
 from sqlalchemy.dialects.postgresql.base import PGDDLCompiler
 from sqlalchemy.dialects.postgresql.psycopg2 import PGDialect_psycopg2
 
+try:
+    import alembic
+except ImportError:
+    pass
+else:
+    from alembic.ddl import postgresql
+
+    class TimescaledbImpl(postgresql.PostgresqlImpl):
+        __dialect__ = 'timescaledb'
+
 
 class TimescaledbDDLCompiler(PGDDLCompiler):
     def post_create_table(self, table):

tests/alembic.ini

@@ -0,0 +1,105 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = ./migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

tests/migrations/env.py

@@ -0,0 +1,76 @@
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+from models import Base #, database_url, Metric, User
+config.set_section_option(
+    config.config_ini_section,
+    "sqlalchemy.url",
+    # database_url.render_as_string(hide_password=False)
+    'timescaledb://user:password@0.0.0.0:5432/database'
+)
+
+target_metadata = Base.metadata
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection, target_metadata=target_metadata
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

tests/migrations/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

tests/migrations/versions/.empty

@@ -3,37 +3,19 @@
 
 from sqlalchemy import Column, String, DateTime, Float, Integer
 from sqlalchemy import create_engine
-from sqlalchemy.dialects import registry
 from sqlalchemy.engine import URL
 from sqlalchemy.orm import declarative_base
 from sqlalchemy.orm import sessionmaker, scoped_session
 
-registry.register(
-    'timescaledb',
-    'sqlalchemy_timescaledb.dialect',
-    'TimescaledbPsycopg2Dialect'
-)
-registry.register(
-    'timescaledb.psycopg2',
-    'sqlalchemy_timescaledb.dialect',
-    'TimescaledbPsycopg2Dialect'
-)
-registry.register(
-    'timescaledb.asyncpg',
-    'sqlalchemy_timescaledb.dialect',
-    'TimescaledbAsyncpgDialect'
-)
-
-engine = create_engine(
-    URL.create(
-        host=os.environ.get('POSTGRES_HOST', '0.0.0.0'),
-        port=os.environ.get('POSTGRES_PORT', 5432),
-        username=os.environ.get('POSTGRES_USER', 'user'),
-        password=os.environ.get('POSTGRES_PASSWORD', 'password'),
-        database=os.environ.get('POSTGRES_DB', 'database'),
-        drivername=os.environ.get('DRIVERNAME', 'timescaledb')
-    )
+database_url = URL.create(
+    host=os.environ.get('POSTGRES_HOST', '0.0.0.0'),
+    port=os.environ.get('POSTGRES_PORT', 5432),
+    username=os.environ.get('POSTGRES_USER', 'user'),
+    password=os.environ.get('POSTGRES_PASSWORD', 'password'),
+    database=os.environ.get('POSTGRES_DB', 'database'),
+    drivername=os.environ.get('DRIVERNAME', 'timescaledb')
 )
+engine = create_engine(database_url)
 Session = scoped_session(sessionmaker(bind=engine))
 Base = declarative_base()