summaryrefslogtreecommitdiffstats
path: root/compass-tasks/utils/flags.py
blob: a3169f56b99beaee906bccd01b7980790f43b053 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# Copyright 2014 Huawei Technologies Co. Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Module to load flags.

   .. moduleauthor:: Xiaodong Wang <xiaodongwang@huawei.com>
"""
import sys

from optparse import OptionParser


class Flags(object):
    """Class to store flags."""

    PARSER = OptionParser()
    PARSED_OPTIONS = None

    @classmethod
    def parse_args(cls):
        """parse args."""
        (options, argv) = Flags.PARSER.parse_args()
        sys.argv = [sys.argv[0]] + argv
        Flags.PARSED_OPTIONS = options

    def __getattr__(self, name):
        if Flags.PARSED_OPTIONS and hasattr(Flags.PARSED_OPTIONS, name):
            return getattr(Flags.PARSED_OPTIONS, name)

        for option in Flags.PARSER.option_list:
            if option.dest == name:
                return option.default

        raise AttributeError('Option instance has no attribute %s' % name)

    def __setattr__(self, name, value):
        if Flags.PARSED_OPTIONS and hasattr(Flags.PARSED_OPTIONS, name):
            setattr(Flags.PARSED_OPTIONS, name, value)
            return

        for option in Flags.PARSER.option_list:
            if option.dest == name:
                option.default = value
                return

        object.__setattr__(self, name, value)


OPTIONS = Flags()


def init():
    """Init flag parsing."""
    OPTIONS.parse_args()


def add(flagname, **kwargs):
    """Add a flag name and its setting.

    :param flagname: flag name declared in cmd as --<flagname>=...
    :type flagname: str
    """
    Flags.PARSER.add_option('--%s' % flagname,
                            dest=flagname, **kwargs)


def add_bool(flagname, default=True, **kwargs):
    """Add a bool flag name and its setting.

    :param flagname: flag name declared in cmd as --[no]<flagname>.
    :type flagname: str
    :param default: default value
    :type default: bool
    """
    Flags.PARSER.add_option('--%s' % flagname,
                            dest=flagname, default=default,
                            action="store_true", **kwargs)
    Flags.PARSER.add_option('--no%s' % flagname,
                            dest=flagname,
                            action="store_false", **kwargs)