[Piglit] [PATCH 1/4] framework: split some parser code out into a share module

[Dylan Baker]

This will be used in subsequent patches to fix bugs in other parsers
which need to implement the same logic.

Signed-off-by: Dylan Baker <dylanx.c.baker at intel.com>
---
 framework/programs/parsers.py | 63 +++++++++++++++++++++++++++++++++++++++++++
 framework/programs/run.py     | 15 ++---------
 2 files changed, 65 insertions(+), 13 deletions(-)
 create mode 100644 framework/programs/parsers.py

diff --git a/framework/programs/parsers.py b/framework/programs/parsers.py
new file mode 100644
index 0000000..572ac18
--- /dev/null
+++ b/framework/programs/parsers.py
@@ -0,0 +1,63 @@
+# Copyright (c) 2015 Intel Corporation
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Shared parsers for use in multiple modules.
+
+Much of this module is based on taking advantage of ArgumentParser's parent
+argument and it's parse_known_args() method. The idea is that some parts of
+parsers can be shared to reduce code duplication, either by parsing the
+argumetns early and acting on them, or by inheriting from a parent object.
+
+"""
+
+from __future__ import absolute_import, division, print_function
+import argparse
+
+from framework import core
+
+# parse the config file before any other options, this allows the config file
+# to be used to set default values for the parser.
+CONFIG = argparse.ArgumentParser(add_help=False)
+CONFIG.add_argument("-f", "--config",
+                    dest="config_file",
+                    type=argparse.FileType("r"),
+                    help="override piglit.conf search path")
+
+
+def parse_config(input_):
+    """Convenience method for the CONFIG parser.
+
+    This returns a two element tuple, the first element is a namespace with the
+    known arguments in it (in this case the config_file), and the second is the
+    remaining unparsed arguments. These remaining arguments should be passed to
+    a new ArgumentParser instance.
+
+    This will also call core.get_config on the config file. The parsed options
+    are passed to ensure API compatibility
+
+    """
+    parsed, unparsed = CONFIG.parse_known_args(input_)
+
+    # Read the config file
+    # We want to read this before we finish parsing since some default options
+    # are set in the config file.
+    core.get_config(parsed.config_file)
+
+    return parsed, unparsed
diff --git a/framework/programs/run.py b/framework/programs/run.py
index 2981ffa..a4fb820 100644
--- a/framework/programs/run.py
+++ b/framework/programs/run.py
@@ -32,6 +32,7 @@ import ctypes
 from framework import core, backends, exceptions
 import framework.results
 import framework.profile
+from . import parsers
 
 __all__ = ['run',
            'resume']
@@ -87,19 +88,7 @@ def _default_backend():
 
 def _run_parser(input_):
     """ Parser for piglit run command """
-    # Parse the config file before any other options, this allows the config
-    # file to be used to sete default values for the parser.
-    parser = argparse.ArgumentParser(add_help=False)
-    parser.add_argument("-f", "--config",
-                        dest="config_file",
-                        type=argparse.FileType("r"),
-                        help="override piglit.conf search path")
-    known, unparsed = parser.parse_known_args(input_)
-
-    # Read the config file
-    # We want to read this before we finish parsing since some default options
-    # are set in the config file.
-    core.get_config(known.config_file)
+    unparsed = parsers.parse_config(input_)[1]
 
     parser = argparse.ArgumentParser()
     parser.add_argument("-n", "--name",
-- 
2.5.0