Refactor CommandLine command registration
#1611
+203
−203
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -348,172 +348,151 @@ class CommandLine: | ||
| def __init__(self, prog: Optional[str] = None) -> None: | ||
| self._generate_args(prog) | ||
|
|
||
| _KWARGS_OPTS = { | ||
| "template": ( | ||
| "-t", | ||
| "--template", | ||
| dict( | ||
| default="generic", | ||
| type=str, | ||
| help="Setup template for use with 'init'", | ||
| ), | ||
| ), | ||
| "message": ( | ||
| "-m", | ||
| "--message", | ||
| dict(type=str, help="Message string to use with 'revision'"), | ||
| ), | ||
| "sql": ( | ||
| "--sql", | ||
| dict( | ||
| action="store_true", | ||
| help="Don't emit SQL to database - dump to " | ||
| "standard output/file instead. See docs on " | ||
| "offline mode.", | ||
| ), | ||
| ), | ||
| "tag": ( | ||
| "--tag", | ||
| dict( | ||
| type=str, | ||
| help="Arbitrary 'tag' name - can be used by " | ||
| "custom env.py scripts.", | ||
| ), | ||
| ), | ||
| "head": ( | ||
| "--head", | ||
| dict( | ||
| type=str, | ||
| help="Specify head revision or <branchname>@head " | ||
| "to base new revision on.", | ||
| ), | ||
| ), | ||
| "splice": ( | ||
| "--splice", | ||
| dict( | ||
| action="store_true", | ||
| help="Allow a non-head revision as the 'head' to splice onto", | ||
| ), | ||
| ), | ||
| "depends_on": ( | ||
| "--depends-on", | ||
| dict( | ||
| action="append", | ||
| help="Specify one or more revision identifiers " | ||
| "which this revision should depend on.", | ||
| ), | ||
| ), | ||
| "rev_id": ( | ||
| "--rev-id", | ||
| dict( | ||
| type=str, | ||
| help="Specify a hardcoded revision id instead of " | ||
| "generating one", | ||
| ), | ||
| ), | ||
| "version_path": ( | ||
| "--version-path", | ||
| dict( | ||
| type=str, | ||
| help="Specify specific path from config for version file", | ||
| ), | ||
| ), | ||
| "branch_label": ( | ||
| "--branch-label", | ||
| dict( | ||
| type=str, | ||
| help="Specify a branch label to apply to the new revision", | ||
| ), | ||
| ), | ||
| "verbose": ( | ||
| "-v", | ||
| "--verbose", | ||
| dict(action="store_true", help="Use more verbose output"), | ||
| ), | ||
| "resolve_dependencies": ( | ||
| "--resolve-dependencies", | ||
| dict( | ||
| action="store_true", | ||
| help="Treat dependency versions as down revisions", | ||
| ), | ||
| ), | ||
| "autogenerate": ( | ||
| "--autogenerate", | ||
| dict( | ||
| action="store_true", | ||
| help="Populate revision script with candidate " | ||
| "migration operations, based on comparison " | ||
| "of database to model.", | ||
| ), | ||
| ), | ||
| "rev_range": ( | ||
| "-r", | ||
| "--rev-range", | ||
| dict( | ||
| action="store", | ||
| help="Specify a revision range; format is [start]:[end]", | ||
| ), | ||
| ), | ||
| "indicate_current": ( | ||
| "-i", | ||
| "--indicate-current", | ||
| dict( | ||
| action="store_true", | ||
| help="Indicate the current revision", | ||
| ), | ||
| ), | ||
| "purge": ( | ||
| "--purge", | ||
| dict( | ||
| action="store_true", | ||
| help="Unconditionally erase the version table before stamping", | ||
| ), | ||
| ), | ||
| "package": ( | ||
| "--package", | ||
| dict( | ||
| action="store_true", | ||
| help="Write empty __init__.py files to the " | ||
| "environment and version locations", | ||
| ), | ||
| ), | ||
| } | ||
| _POSITIONAL_OPTS = { | ||
| "directory": dict(help="location of scripts directory"), | ||
| "revision": dict( | ||
| help="revision identifier", | ||
| ), | ||
| "revisions": dict( | ||
| nargs="+", | ||
| help="one or more revisions, or 'heads' for all heads", | ||
| ), | ||
| } | ||
| _POSITIONAL_TRANSLATIONS: dict[Any, dict[str, str]] = { | ||
| command.stamp: {"revision": "revisions"} | ||
| } | ||
|
|
||
| def _generate_args(self, prog: Optional[str]) -> None: | ||
| parser = ArgumentParser(prog=prog) | ||
|
|
||
| parser.add_argument( | ||
| @@ -532,7 +511,7 @@ def add_options( | ||
| "--name", | ||
| type=str, | ||
| default="alembic", | ||
| help="Name of section in .ini file to use for Alembic config", | ||
| ) | ||
| parser.add_argument( | ||
| "-x", | ||
| @@ -552,50 +531,71 @@ def add_options( | ||
| action="store_true", | ||
| help="Do not log to std output.", | ||
| ) | ||
|
|
||
| self.subparsers = parser.add_subparsers() | ||
| alembic_commands = ( | ||
| fn | ||
| for fn in (getattr(command, name) for name in dir(command)) | ||
| if ( | ||
| inspect.isfunction(fn) | ||
| and fn.__name__[0] != "_" | ||
| and fn.__module__ == "alembic.command" | ||
| ) | ||
| ) | ||
|
|
||
| for fn in alembic_commands: | ||
| self._register_command(fn) | ||
|
|
||
| self.parser = parser | ||
|
|
||
| def _register_command(self, fn: Any) -> None: | ||
| positional, kwarg, help_text = self._inspect_function(fn) | ||
|
|
||
| subparser = self.subparsers.add_parser(fn.__name__, help=help_text) | ||
| subparser.set_defaults(cmd=(fn, positional, kwarg)) | ||
|
|
||
| for arg in kwarg: | ||
| if arg in self._KWARGS_OPTS: | ||
| kwarg_opt = self._KWARGS_OPTS[arg] | ||
| args, opts = kwarg_opt[0:-1], kwarg_opt[-1] | ||
|
There was a problem hiding this comment. Federico Caselli (CaselIT) wrote: Done View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/5718 |
||
| subparser.add_argument(*args, **opts) # type:ignore | ||
|
|
||
| for arg in positional: | ||
| if arg in self._POSITIONAL_OPTS: | ||
|
There was a problem hiding this comment. Federico Caselli (CaselIT) wrote: Done View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/5718 |
||
| opts = self._POSITIONAL_OPTS[arg] | ||
| subparser.add_argument(arg, **opts) # type:ignore | ||
|
|
||
| def _inspect_function(self, fn: Any) -> tuple[Any, Any, str]: | ||
| spec = compat.inspect_getfullargspec(fn) | ||
| if spec[3] is not None: | ||
| positional = spec[0][1 : -len(spec[3])] | ||
| kwarg = spec[0][-len(spec[3]) :] | ||
| else: | ||
| positional = spec[0][1:] | ||
| kwarg = [] | ||
|
|
||
| if fn in self._POSITIONAL_TRANSLATIONS: | ||
| positional = [ | ||
| self._POSITIONAL_TRANSLATIONS[fn].get(name, name) | ||
| for name in positional | ||
| ] | ||
|
|
||
| # parse first line(s) of helptext without a line break | ||
| help_ = fn.__doc__ | ||
| if help_: | ||
| help_lines = [] | ||
| for line in help_.split("\n"): | ||
| if not line.strip(): | ||
| break | ||
| else: | ||
| help_lines.append(line.strip()) | ||
| else: | ||
| help_lines = [] | ||
|
|
||
| help_text = " ".join(help_lines) | ||
|
|
||
| return positional, kwarg, help_text | ||
|
|
||
| def run_cmd(self, config: Config, options: Namespace) -> None: | ||
| fn, positional, kwarg = options.cmd | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Federico Caselli (CaselIT) wrote:
Done
View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/5718