add generate_revision_from_script to autogenerate.api #35

tysonholub · 2017-01-19T22:04:04Z

allows a revision to be generated against a provided migration_script (it seemed more appropriate to define a new function rather than tweak the render_python_code helper)

Ex:

from alembic.autogenerate import api
from alembic.config import Config
from alembic.operations import ops
import sqlalchemy as sa
import os

config = Config(os.environ['ALEMBIC_CONFIG'])

migration_script = ops.MigrationScript(
    rev_id=None,
    message='add test table',
    upgrade_ops=ops.UpgradeOps(
        ops=[
            ops.CreateTableOp(
                'test_table',
                [
                    sa.Column('id', sa.Integer(), primary_key=True),
                    sa.Column('name', sa.String(50), nullable=False)
                ]
            ),
        ]
    ),
    downgrade_ops=ops.DowngradeOps(
        ops=[
            ops.DropTableOp('test_table')
        ]
    ),
)

api.generate_revision_from_script(config, migration_script)

zzzeek

needs a unit test in test_script_production. It would be a new test class that has just one test to start with, runs the function then uses os.access(fname, os.F_OK) to make sure the file was written. setup and teardown can likely be:

class ProgammaticGenerationTest(TestBase):

    def setUp(self):
        staging_env()
        self.cfg = _no_sql_testing_config(
            directives="\nrevision_environment=true\n"
        )

    def tearDown(self):
        clear_staging_env()


    def test_gen_revision_from_script(self):
    	migration_script = ...

    	rev = generate_revision_from_script(self.cfg, migration_script)

    	assert os.access(rev.<get_the_filename>, os.F.OK)

zzzeek · 2017-01-23T17:08:28Z

alembic/autogenerate/api.py

+            'user_module_prefix': None,
+        }, autogenerate=False)
+
+    revision_context.generated_revisions[0].upgrade_ops = migration_script.upgrade_ops


can we say:

revision_context.generated_revisions[0] = migration_script

?

zzzeek · 2017-01-23T17:08:50Z

alembic/autogenerate/api.py

@@ -181,6 +181,41 @@ def _render_migration_diffs(context, template_args):
    )


+def generate_revision_from_script(config, migration_script):
+    from ..script import ScriptDirectory


imports at the top of file...

When I import at the top of the file I get this ImportError

Traceback (most recent call last): File "migrate_test.py", line 1, in <module> from alembic.autogenerate import api File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/__init__.py", line 9, in <module> from . import context # noqa File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/context.py", line 1, in <module> from .runtime.environment import EnvironmentContext File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/runtime/environment.py", line 2, in <module> from .migration import MigrationContext File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/runtime/migration.py", line 11, in <module> from .. import ddl, util File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/ddl/__init__.py", line 1, in <module> from . import postgresql, mysql, sqlite, mssql, oracle # pragma: no cover File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/ddl/mysql.py", line 12, in <module> from ..autogenerate import compare File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/autogenerate/__init__.py", line 1, in <module> from .api import ( # noqa File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/autogenerate/api.py", line 5, in <module> from ..script import ScriptDirectory File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/script/__init__.py", line 1, in <module> from .base import ScriptDirectory, Script # noqa File "/home/vagrant/.pyenv/versions/dtools/lib/python2.7/site-packages/alembic/script/base.py", line 8, in <module> from ..runtime import migration ImportError: cannot import name migration

zzzeek · 2017-01-23T17:09:05Z

alembic/autogenerate/api.py

@@ -181,6 +181,41 @@ def _render_migration_diffs(context, template_args):
    )


+def generate_revision_from_script(config, migration_script):


docstring w/ params

zzzeek · 2017-01-23T17:10:18Z

alembic/autogenerate/api.py

+    revision_context = RevisionContext(
+        config, script_directory, command_args)
+
+    revision_context._last_autogen_context = AutogenContext(


look at render_python_code(), these prefixes are all configurable.

I'd prefer if render_python_code and this function could somehow derive from more common elements but this is a good start for now.

…est_script_production

tysonholub · 2017-01-23T22:21:16Z

pushed a new commit. I'm only unsure about the ScriptDirectory ImportError when import at top of the file. Thanks!

zzzeek · 2017-01-23T22:28:35Z

the import is not a big deal but suggests the organization of the modules here is working aginast what you want to do. id have to take a look. can we make those "prefix" options available to change in the function def ? I can take it after that.

… signature

tysonholub · 2017-01-24T01:01:48Z

pushed optional prefixes into signature

zzzeek · 2017-01-30T14:34:29Z

don't panic, I'm transferring this to gerrit

zzzeek · 2017-01-30T14:34:54Z

Dear contributor -

This pull request is being moved to Gerrit, at https://gerrit.sqlalchemy.org/303, where it may be tested and reviewed more closely. As such, the pull request itself is being marked "closed" or "declined", however your contribution is merely being moved to our central review system. Please register at https://gerrit.sqlalchemy.org#/register/ to send and receive comments regarding this item.

tysonholub · 2017-01-30T15:19:17Z

Thanks for the update. I will follow on Gerrit

This allows programmatic use of command.revision() to specify an ad-hoc process_revision_directives callable, rather than having it placed via the env.py script. Co-authored-by: Tyson Holub Change-Id: Ief1c11fd2a6f10e712851145d6d190a3b167817c Pull-request: #35

add generate_revision_from_script to autogenerate.api

9a4ee51

zzzeek requested changes Jan 23, 2017

View reviewed changes

refactor generate_revision_from_script and implement test for it in t…

db408f6

…est_script_production

tysonholub force-pushed the master branch from 159efb2 to db408f6 Compare January 23, 2017 22:17

add optional prefix options to generate_revision_from_script function…

ff8c699

… signature

zzzeek closed this Jan 30, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add generate_revision_from_script to autogenerate.api #35

add generate_revision_from_script to autogenerate.api #35

tysonholub commented Jan 19, 2017

zzzeek left a comment

zzzeek Jan 23, 2017

zzzeek Jan 23, 2017

tysonholub Jan 23, 2017

zzzeek Jan 23, 2017

zzzeek Jan 23, 2017

tysonholub commented Jan 23, 2017

zzzeek commented Jan 23, 2017

tysonholub commented Jan 24, 2017

zzzeek commented Jan 30, 2017

zzzeek commented Jan 30, 2017

tysonholub commented Jan 30, 2017

		@@ -181,6 +181,41 @@ def _render_migration_diffs(context, template_args):
		)


		def generate_revision_from_script(config, migration_script):

add generate_revision_from_script to autogenerate.api #35

add generate_revision_from_script to autogenerate.api #35

Conversation

tysonholub commented Jan 19, 2017

zzzeek left a comment

Choose a reason for hiding this comment

zzzeek Jan 23, 2017

Choose a reason for hiding this comment

zzzeek Jan 23, 2017

Choose a reason for hiding this comment

tysonholub Jan 23, 2017

Choose a reason for hiding this comment

zzzeek Jan 23, 2017

Choose a reason for hiding this comment

zzzeek Jan 23, 2017

Choose a reason for hiding this comment

tysonholub commented Jan 23, 2017

zzzeek commented Jan 23, 2017

tysonholub commented Jan 24, 2017

zzzeek commented Jan 30, 2017

zzzeek commented Jan 30, 2017

tysonholub commented Jan 30, 2017