Refactoring: move shared options to their own module

Signed-off-by: Karl Hasselström <kha@treskal.com>

diff --git a/stgit/argparse.py b/stgit/argparse.py
new file mode 100644 (file)
index 0000000..4999272
--- /dev/null
+++ b/stgit/argparse.py
@@ -0,0 +1,106 @@
+"""Utility functions for command-line option parsing."""
+
+import optparse, sys
+from stgit import utils
+from stgit.config import config
+
+def sign_options():
+    def callback(option, opt_str, value, parser, sign_str):
+        if parser.values.sign_str not in [None, sign_str]:
+            raise optparse.OptionValueError(
+                '--ack and --sign were both specified')
+        parser.values.sign_str = sign_str
+    return [optparse.make_option('--sign', action = 'callback',
+                                 callback = callback, dest = 'sign_str',
+                                 callback_args = ('Signed-off-by',),
+                                 help = 'add Signed-off-by line'),
+            optparse.make_option('--ack', action = 'callback',
+                                 callback = callback, dest = 'sign_str',
+                                 callback_args = ('Acked-by',),
+                                 help = 'add Acked-by line')]
+
+def message_options():
+    def no_dup(parser):
+        if parser.values.message != None:
+            raise optparse.OptionValueError(
+                'Cannot give more than one --message or --file')
+    def no_combine(parser):
+        if (parser.values.message != None
+            and parser.values.save_template != None):
+            raise optparse.OptionValueError(
+                'Cannot give both --message/--file and --save-template')
+    def msg_callback(option, opt_str, value, parser):
+        no_dup(parser)
+        parser.values.message = value
+        no_combine(parser)
+    def file_callback(option, opt_str, value, parser):
+        no_dup(parser)
+        if value == '-':
+            parser.values.message = sys.stdin.read()
+        else:
+            f = file(value)
+            parser.values.message = f.read()
+            f.close()
+        no_combine(parser)
+    def templ_callback(option, opt_str, value, parser):
+        if value == '-':
+            def w(s):
+                sys.stdout.write(s)
+        else:
+            def w(s):
+                f = file(value, 'w+')
+                f.write(s)
+                f.close()
+        parser.values.save_template = w
+        no_combine(parser)
+    m = optparse.make_option
+    return [m('-m', '--message', action = 'callback', callback = msg_callback,
+              dest = 'message', type = 'string',
+              help = 'use MESSAGE instead of invoking the editor'),
+            m('-f', '--file', action = 'callback', callback = file_callback,
+              dest = 'message', type = 'string', metavar = 'FILE',
+              help = 'use FILE instead of invoking the editor'),
+            m('--save-template', action = 'callback', callback = templ_callback,
+              metavar = 'FILE', dest = 'save_template', type = 'string',
+              help = 'save the message template to FILE and exit')]
+
+def diff_opts_option():
+    def diff_opts_callback(option, opt_str, value, parser):
+        if value:
+            parser.values.diff_flags.extend(value.split())
+        else:
+            parser.values.diff_flags = []
+    return [optparse.make_option(
+        '-O', '--diff-opts', dest = 'diff_flags',
+        default = (config.get('stgit.diff-opts') or '').split(),
+        action = 'callback', callback = diff_opts_callback,
+        type = 'string', metavar = 'OPTIONS',
+        help = 'extra options to pass to "git diff"')]
+
+def person_opts(person, short):
+    """Sets options.<person> to a function that modifies a Person
+    according to the commandline options."""
+    def short_callback(option, opt_str, value, parser, field):
+        f = getattr(parser.values, person)
+        setattr(parser.values, person,
+                lambda p: getattr(f(p), 'set_' + field)(value))
+    def full_callback(option, opt_str, value, parser):
+        ne = utils.parse_name_email(value)
+        if not ne:
+            raise optparse.OptionValueError(
+                'Bad %s specification: %r' % (opt_str, value))
+        name, email = ne
+        short_callback(option, opt_str, name, parser, 'name')
+        short_callback(option, opt_str, email, parser, 'email')
+    return ([optparse.make_option(
+                '--%s' % person, metavar = '"NAME <EMAIL>"', type = 'string',
+                action = 'callback', callback = full_callback, dest = person,
+                default = lambda p: p, help = 'set the %s details' % person)]
+            + [optparse.make_option(
+                '--%s%s' % (short, f), metavar = f.upper(), type = 'string',
+                action = 'callback', callback = short_callback, dest = person,
+                callback_args = (f,), help = 'set the %s %s' % (person, f))
+               for f in ['name', 'email', 'date']])
+
+def author_committer_options():
+    return person_opts('author', 'auth') + person_opts('committer', 'comm')

diff --git a/stgit/commands/coalesce.py b/stgit/commands/coalesce.py
index 1a349348df66bcaf9c00c61bf360d37276d689fc..2d672bbe3276819a30f0aa7c878f6a1436fd8e73 100644 (file)
--- a/stgit/commands/coalesce.py
+++ b/stgit/commands/coalesce.py
@@ -19,7 +19,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 from optparse import make_option
 from stgit.out import *
 
 from optparse import make_option
 from stgit.out import *

-from stgit import utils
+from stgit import argparse, utils

 from stgit.commands import common
 from stgit.lib import git, transaction
 
 from stgit.commands import common
 from stgit.lib import git, transaction
 


@@ -35,7 +35,7 @@ done a sequence of pushes and pops yourself."""
 
 directory = common.DirectoryHasRepositoryLib()
 options = [make_option('-n', '--name', help = 'name of coalesced patch')
 
 directory = common.DirectoryHasRepositoryLib()
 options = [make_option('-n', '--name', help = 'name of coalesced patch')

-           ] + utils.make_message_options()
+           ] + argparse.message_options()

 
 class SaveTemplateDone(Exception):
     pass
 
 class SaveTemplateDone(Exception):
     pass

diff --git a/stgit/commands/diff.py b/stgit/commands/diff.py
index 1237c854c5fffbcc994e4031cad52d87a6dacc2a..4f3e2c45e06afe464ac557a63b864f0436585330 100644 (file)
--- a/stgit/commands/diff.py
+++ b/stgit/commands/diff.py
@@ -23,8 +23,7 @@ from pydoc import pager
 from stgit.commands.common import *
 from stgit.utils import *
 from stgit.out import *
 from stgit.commands.common import *
 from stgit.utils import *
 from stgit.out import *

-from stgit import stack, git
-
+from stgit import argparse, stack, git

 
 help = 'show the tree diff'
 usage = """%prog [options] [<files or dirs>]
 
 help = 'show the tree diff'
 usage = """%prog [options] [<files or dirs>]


@@ -46,7 +45,7 @@ options = [make_option('-r', '--range',
            make_option('-s', '--stat',
                        help = 'show the stat instead of the diff',
                        action = 'store_true')
            make_option('-s', '--stat',
                        help = 'show the stat instead of the diff',
                        action = 'store_true')

-           ] + make_diff_opts_option()
+           ] + argparse.diff_opts_option()

 
 def func(parser, options, args):
     """Show the tree diff
 
 def func(parser, options, args):
     """Show the tree diff

diff --git a/stgit/commands/edit.py b/stgit/commands/edit.py
index 3b36a6ceafe7073068a28b282487af95c1f6f1df..92447a8c80a445e3bb62115ca1b3c987a31c5934 100644 (file)
--- a/stgit/commands/edit.py
+++ b/stgit/commands/edit.py
@@ -20,7 +20,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 from optparse import make_option
 
 
 from optparse import make_option
 

-from stgit import git, utils
+from stgit import argparse, git, utils

 from stgit.commands import common
 from stgit.lib import git as gitlib, transaction
 from stgit.out import *
 from stgit.commands import common
 from stgit.lib import git as gitlib, transaction
 from stgit.out import *


@@ -60,9 +60,9 @@ options = [make_option('-d', '--diff',
                        action = 'store_true'),
            make_option('-e', '--edit', action = 'store_true',
                        help = 'invoke interactive editor'),
                        action = 'store_true'),
            make_option('-e', '--edit', action = 'store_true',
                        help = 'invoke interactive editor'),

-           ] + (utils.make_sign_options() + utils.make_message_options()
-                + utils.make_author_committer_options()
-                + utils.make_diff_opts_option())
+           ] + (argparse.sign_options() + argparse.message_options()
+                + argparse.author_committer_options()
+                + argparse.diff_opts_option())

 
 def patch_diff(repository, cd, diff, diff_flags):
     if diff:
 
 def patch_diff(repository, cd, diff, diff_flags):
     if diff:

diff --git a/stgit/commands/export.py b/stgit/commands/export.py
index 183a1b570cf1cad1e1bcddd27242ca0314782f2d..fb373a96b5d50ce365075f7c30b554197ff9494c 100644 (file)
--- a/stgit/commands/export.py
+++ b/stgit/commands/export.py
@@ -22,7 +22,7 @@ import os
 from optparse import make_option
 
 from stgit.commands import common
 from optparse import make_option
 
 from stgit.commands import common

-from stgit import git, utils, templates
+from stgit import argparse, git, templates

 from stgit.out import out
 from stgit.lib import git as gitlib
 
 from stgit.out import out
 from stgit.lib import git as gitlib
 


@@ -66,7 +66,7 @@ options = [make_option('-d', '--dir',
            make_option('-s', '--stdout',
                        help = 'dump the patches to the standard output',
                        action = 'store_true')
            make_option('-s', '--stdout',
                        help = 'dump the patches to the standard output',
                        action = 'store_true')

-           ] + utils.make_diff_opts_option()
+           ] + argparse.diff_opts_option()

 
 def func(parser, options, args):
     """Export a range of patches.
 
 def func(parser, options, args):
     """Export a range of patches.

diff --git a/stgit/commands/files.py b/stgit/commands/files.py
index d240872d326dd6a435b5f5296ac9f1ad9cb91dae..cdb0b526f9bdafb739b3894930a257f05e975de0 100644 (file)
--- a/stgit/commands/files.py
+++ b/stgit/commands/files.py
@@ -22,8 +22,7 @@ from optparse import OptionParser, make_option
 from stgit.commands.common import *
 from stgit.utils import *
 from stgit.out import *
 from stgit.commands.common import *
 from stgit.utils import *
 from stgit.out import *

-from stgit import stack, git
-
+from stgit import argparse, stack, git

 
 help = 'show the files modified by a patch (or the current patch)'
 usage = """%prog [options] [[<branch>:]<patch>]
 
 help = 'show the files modified by a patch (or the current patch)'
 usage = """%prog [options] [[<branch>:]<patch>]


@@ -41,8 +40,7 @@ options = [make_option('-s', '--stat',
            make_option('--bare',
                        help = 'bare file names (useful for scripting)',
                        action = 'store_true')
            make_option('--bare',
                        help = 'bare file names (useful for scripting)',
                        action = 'store_true')

-           ] + make_diff_opts_option()
-
+           ] + argparse.diff_opts_option()

 
 def func(parser, options, args):
     """Show the files modified by a patch (or the current patch)
 
 def func(parser, options, args):
     """Show the files modified by a patch (or the current patch)

diff --git a/stgit/commands/imprt.py b/stgit/commands/imprt.py
index 227743f51554f027832f143ef6b4c30e76809f72..e649ed7c632ba15a72533f6b52130148d2db606e 100644 (file)
--- a/stgit/commands/imprt.py
+++ b/stgit/commands/imprt.py
@@ -23,8 +23,7 @@ from optparse import OptionParser, make_option
 from stgit.commands.common import *
 from stgit.utils import *
 from stgit.out import *
 from stgit.commands.common import *
 from stgit.utils import *
 from stgit.out import *

-from stgit import stack, git
-
+from stgit import argparse, stack, git

 
 help = 'import a GNU diff file as a new patch'
 usage = """%prog [options] [<file>|<url>]
 
 help = 'import a GNU diff file as a new patch'
 usage = """%prog [options] [<file>|<url>]


@@ -88,7 +87,7 @@ options = [make_option('-m', '--mail',
                        help = 'use COMMNAME as the committer name'),
            make_option('--commemail',
                        help = 'use COMMEMAIL as the committer e-mail')
                        help = 'use COMMNAME as the committer name'),
            make_option('--commemail',
                        help = 'use COMMEMAIL as the committer e-mail')

-           ] + make_sign_options()
+           ] + argparse.sign_options()

 
 
 def __strip_patch_name(name):
 
 
 def __strip_patch_name(name):

diff --git a/stgit/commands/mail.py b/stgit/commands/mail.py
index 4e7ed2f0e4fee38905271cb08ce035644b946bd7..521c8eb26fe83b1f98f810522c2f64fdfe93c3cf 100644 (file)
--- a/stgit/commands/mail.py
+++ b/stgit/commands/mail.py
@@ -22,7 +22,7 @@ from optparse import OptionParser, make_option
 from stgit.commands.common import *
 from stgit.utils import *
 from stgit.out import *
 from stgit.commands.common import *
 from stgit.utils import *
 from stgit.out import *

-from stgit import stack, git, version, templates
+from stgit import argparse, stack, git, version, templates

 from stgit.config import config
 from stgit.run import Run
 
 from stgit.config import config
 from stgit.run import Run
 


@@ -151,8 +151,7 @@ options = [make_option('-a', '--all',
            make_option('-m', '--mbox',
                        help = 'generate an mbox file instead of sending',
                        action = 'store_true')
            make_option('-m', '--mbox',
                        help = 'generate an mbox file instead of sending',
                        action = 'store_true')

-           ] + make_diff_opts_option()
-
+           ] + argparse.diff_opts_option()

 
 def __get_sender():
     """Return the 'authname <authemail>' string as read from the
 
 def __get_sender():
     """Return the 'authname <authemail>' string as read from the

diff --git a/stgit/commands/new.py b/stgit/commands/new.py
index c4ee4e141dc8e2d62a40d46b2634df4a391204a0..eb45e1b814085d1b5e3b8c6895100ec06eee1970 100644 (file)
--- a/stgit/commands/new.py
+++ b/stgit/commands/new.py
@@ -18,7 +18,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 from optparse import make_option
 
 
 from optparse import make_option
 

-from stgit import utils
+from stgit import argparse, utils

 from stgit.commands import common
 from stgit.lib import git as gitlib, transaction
 
 from stgit.commands import common
 from stgit.lib import git as gitlib, transaction
 


@@ -37,8 +37,8 @@ If no name is given for the new patch, one is generated from the first
 line of the commit message."""
 
 directory = common.DirectoryHasRepositoryLib()
 line of the commit message."""
 
 directory = common.DirectoryHasRepositoryLib()

-options = (utils.make_author_committer_options()
-           + utils.make_message_options() + utils.make_sign_options())
+options = (argparse.author_committer_options()
+           + argparse.message_options() + argparse.sign_options())

 
 def func(parser, options, args):
     """Create a new patch."""
 
 def func(parser, options, args):
     """Create a new patch."""

diff --git a/stgit/commands/show.py b/stgit/commands/show.py
index b77a9c8740e08309ed79a7929c271c7050ec698a..36361d6c884c2573df4b9094459593696d91a8ae 100644 (file)
--- a/stgit/commands/show.py
+++ b/stgit/commands/show.py
@@ -20,8 +20,7 @@ from optparse import OptionParser, make_option
 from pydoc import pager
 
 from stgit.commands.common import *
 from pydoc import pager
 
 from stgit.commands.common import *

-from stgit import git
-
+from stgit import argparse, git

 
 help = 'show the commit corresponding to a patch (or the current patch)'
 usage = """%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]
 
 help = 'show the commit corresponding to a patch (or the current patch)'
 usage = """%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]


@@ -39,8 +38,7 @@ options = [make_option('-b', '--branch',
            make_option('-u', '--unapplied',
                        help = 'show the unapplied patches',
                        action = 'store_true')
            make_option('-u', '--unapplied',
                        help = 'show the unapplied patches',
                        action = 'store_true')

-           ] + make_diff_opts_option()
-
+           ] + argparse.diff_opts_option()

 
 def func(parser, options, args):
     """Show commit log and diff
 
 def func(parser, options, args):
     """Show commit log and diff

diff --git a/stgit/utils.py b/stgit/utils.py
index 864975d483947c377ab480048c6ba74a045b3a8d..979fd3bbfa176b6c5df2d5418c7cc1bcdd954629 100644 (file)
--- a/stgit/utils.py
+++ b/stgit/utils.py
@@ -1,7 +1,7 @@
 """Common utility functions
 """
 
 """Common utility functions
 """
 

-import errno, optparse, os, os.path, re, sys
+import errno, os, os.path, re, sys

 from stgit.exception import *
 from stgit.config import config
 from stgit.out import *
 from stgit.exception import *
 from stgit.config import config
 from stgit.out import *


@@ -238,21 +238,6 @@ if not 'all' in dir(__builtins__):
                 return False
         return True
 
                 return False
         return True
 

-def make_sign_options():
-    def callback(option, opt_str, value, parser, sign_str):
-        if parser.values.sign_str not in [None, sign_str]:
-            raise optparse.OptionValueError(
-                '--ack and --sign were both specified')
-        parser.values.sign_str = sign_str
-    return [optparse.make_option('--sign', action = 'callback',
-                                 callback = callback, dest = 'sign_str',
-                                 callback_args = ('Signed-off-by',),
-                                 help = 'add Signed-off-by line'),
-            optparse.make_option('--ack', action = 'callback',
-                                 callback = callback, dest = 'sign_str',
-                                 callback_args = ('Acked-by',),
-                                 help = 'add Acked-by line')]
-

 def add_sign_line(desc, sign_str, name, email):
     if not sign_str:
         return desc
 def add_sign_line(desc, sign_str, name, email):
     if not sign_str:
         return desc


@@ -264,64 +249,6 @@ def add_sign_line(desc, sign_str, name, email):
         desc = desc + '\n'
     return '%s\n%s\n' % (desc, sign_str)
 
         desc = desc + '\n'
     return '%s\n%s\n' % (desc, sign_str)
 

-def make_message_options():
-    def no_dup(parser):
-        if parser.values.message != None:
-            raise optparse.OptionValueError(
-                'Cannot give more than one --message or --file')
-    def no_combine(parser):
-        if (parser.values.message != None
-            and parser.values.save_template != None):
-            raise optparse.OptionValueError(
-                'Cannot give both --message/--file and --save-template')
-    def msg_callback(option, opt_str, value, parser):
-        no_dup(parser)
-        parser.values.message = value
-        no_combine(parser)
-    def file_callback(option, opt_str, value, parser):
-        no_dup(parser)
-        if value == '-':
-            parser.values.message = sys.stdin.read()
-        else:
-            f = file(value)
-            parser.values.message = f.read()
-            f.close()
-        no_combine(parser)
-    def templ_callback(option, opt_str, value, parser):
-        if value == '-':
-            def w(s):
-                sys.stdout.write(s)
-        else:
-            def w(s):
-                f = file(value, 'w+')
-                f.write(s)
-                f.close()
-        parser.values.save_template = w
-        no_combine(parser)
-    m = optparse.make_option
-    return [m('-m', '--message', action = 'callback', callback = msg_callback,
-              dest = 'message', type = 'string',
-              help = 'use MESSAGE instead of invoking the editor'),
-            m('-f', '--file', action = 'callback', callback = file_callback,
-              dest = 'message', type = 'string', metavar = 'FILE',
-              help = 'use FILE instead of invoking the editor'),
-            m('--save-template', action = 'callback', callback = templ_callback,
-              metavar = 'FILE', dest = 'save_template', type = 'string',
-              help = 'save the message template to FILE and exit')]
-
-def make_diff_opts_option():
-    def diff_opts_callback(option, opt_str, value, parser):
-        if value:
-            parser.values.diff_flags.extend(value.split())
-        else:
-            parser.values.diff_flags = []
-    return [optparse.make_option(
-        '-O', '--diff-opts', dest = 'diff_flags',
-        default = (config.get('stgit.diff-opts') or '').split(),
-        action = 'callback', callback = diff_opts_callback,
-        type = 'string', metavar = 'OPTIONS',
-        help = 'extra options to pass to "git diff"')]
-

 def parse_name_email(address):
     """Return a tuple consisting of the name and email parsed from a
     standard 'name <email>' or 'email (name)' string."""
 def parse_name_email(address):
     """Return a tuple consisting of the name and email parsed from a
     standard 'name <email>' or 'email (name)' string."""


@@ -343,35 +270,6 @@ def parse_name_email_date(address):
         return None
     return str_list[0]
 
         return None
     return str_list[0]
 

-def make_person_options(person, short):
-    """Sets options.<person> to a function that modifies a Person
-    according to the commandline options."""
-    def short_callback(option, opt_str, value, parser, field):
-        f = getattr(parser.values, person)
-        setattr(parser.values, person,
-                lambda p: getattr(f(p), 'set_' + field)(value))
-    def full_callback(option, opt_str, value, parser):
-        ne = parse_name_email(value)
-        if not ne:
-            raise optparse.OptionValueError(
-                'Bad %s specification: %r' % (opt_str, value))
-        name, email = ne
-        short_callback(option, opt_str, name, parser, 'name')
-        short_callback(option, opt_str, email, parser, 'email')
-    return ([optparse.make_option(
-                '--%s' % person, metavar = '"NAME <EMAIL>"', type = 'string',
-                action = 'callback', callback = full_callback, dest = person,
-                default = lambda p: p, help = 'set the %s details' % person)]
-            + [optparse.make_option(
-                '--%s%s' % (short, f), metavar = f.upper(), type = 'string',
-                action = 'callback', callback = short_callback, dest = person,
-                callback_args = (f,), help = 'set the %s %s' % (person, f))
-               for f in ['name', 'email', 'date']])
-
-def make_author_committer_options():
-    return (make_person_options('author', 'auth')
-            + make_person_options('committer', 'comm'))
-

 # Exit codes.
 STGIT_SUCCESS = 0        # everything's OK
 STGIT_GENERAL_ERROR = 1  # seems to be non-command-specific error
 # Exit codes.
 STGIT_SUCCESS = 0        # everything's OK
 STGIT_GENERAL_ERROR = 1  # seems to be non-command-specific error