ArgumentParser: allow passing name and default value for version

pekkaklarck · pekkaklarck · commit 84ac7a7affb2 · 2012-01-30T18:28:51.000+02:00
diff --git a/src/robot/utils/argumentparser.py b/src/robot/utils/argumentparser.py
@@ -23,6 +23,7 @@
 import textwrap
 
 from robot.errors import DataError, Information, FrameworkError
+from robot.version import get_full_version
 
 from misc import plural_or_not
 from encoding import decode_output, decode_from_file_system
@@ -52,17 +53,17 @@ class ArgumentParser:
     \s*$
     ''', re.VERBOSE | re.IGNORECASE)
 
-    def __init__(self, usage, version=None, arg_limits=None):
+    def __init__(self, usage, name=None, version=None, arg_limits=None):
         """Available options and tool name are read from the usage.
 
         Tool name is got from the first row of the usage. It is either the
         whole row or anything before first ' -- '.
         """
         if not usage:
             raise FrameworkError('Usage cannot be empty')
+        self.name = name or usage.splitlines()[0].split(' -- ')[0].strip()
+        self.version = version or get_full_version()
         self._usage = usage
-        self._name = usage.splitlines()[0].split(' -- ')[0].strip()
-        self._version = version
         self._arg_limits = arg_limits
         self._short_opts = ''
         self._long_opts = []
@@ -367,8 +368,8 @@ def _get_available_escapes(self):
 
     def _raise_help(self):
         msg = self._usage
-        if self._version:
-            msg = msg.replace('<VERSION>', self._version)
+        if self.version:
+            msg = msg.replace('<VERSION>', self.version)
         def replace_escapes(res):
             escapes = 'Available escapes: ' + self._get_available_escapes()
             lines = textwrap.wrap(escapes, width=len(res.group(2)))
@@ -378,9 +379,7 @@ def replace_escapes(res):
         raise Information(msg)
 
     def _raise_version(self):
-        if not self._version:
-            raise FrameworkError('Version not set')
-        raise Information('%s %s' % (self._name, self._version))
+        raise Information('%s %s' % (self.name, self.version))
 
     def _raise_option_multiple_times_in_usage(self, opt):
         raise FrameworkError("Option '%s' multiple times in usage" % opt)
diff --git a/utest/utils/test_argumentparser.py b/utest/utils/test_argumentparser.py
@@ -4,6 +4,7 @@
 from robot.utils.argumentparser import ArgumentParser
 from robot.utils.asserts import *
 from robot.errors import Information, DataError, FrameworkError
+from robot.version import get_full_version
 
 
 USAGE = """Example Tool -- Stuff before hyphens is considered name
@@ -235,16 +236,22 @@ def test_print_help(self):
                                self.ap2.parse_args, ['--help'])
 
     def test_name_is_got_from_first_line_of_the_usage(self):
-        assert_equals(self.ap._name, 'Example Tool')
-        assert_equals(self.ap2._name, 'Just Name Here')
+        assert_equals(self.ap.name, 'Example Tool')
+        assert_equals(self.ap2.name, 'Just Name Here')
+
+    def test_name_and_version_can_be_given(self):
+        ap = ArgumentParser(USAGE, name='Kakkonen', version='2')
+        assert_equals(ap.name, 'Kakkonen')
+        assert_equals(ap.version, '2')
 
     def test_print_version(self):
         assert_raises_with_msg(Information, 'Example Tool 1.0 alpha',
                                self.ap.parse_args, ['--version'])
 
     def test_print_version_when_version_not_set(self):
-        ap = ArgumentParser(' --version')
-        assert_raises(FrameworkError, ap.parse_args, ['--version'])
+        ap = ArgumentParser(' --version', name='Kekkonen')
+        msg = assert_raises(Information, ap.parse_args, ['--version'])
+        assert_equals(unicode(msg), 'Kekkonen %s' % get_full_version())
 
     def test_version_is_replaced_in_help(self):
         assert_raises_with_msg(Information, USAGE.replace('<VERSION>', '1.0 alpha'),
