/
cfg.py
3228 lines (2520 loc) · 114 KB
/
cfg.py
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2012 Red Hat, Inc.
#
# 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.
"""Primary module in oslo_config.
"""
import argparse
import collections
# TODO(smcginnis) update this once six has support for collections.abc
# (https://github.com/benjaminp/six/pull/241) or clean up once we drop py2.7.
try:
from collections.abc import Mapping
except ImportError:
from collections import Mapping
import copy
import errno
import functools
import glob
import inspect
import itertools
import logging
import os
import string
import sys
import enum
import six
# NOTE(bnemec): oslo.log depends on oslo.config, so we can't
# have a hard dependency on oslo.log. However, in most cases
# oslo.log will be installed so we can use it.
try:
import oslo_log
except ImportError:
oslo_log = None
from oslo_config import iniparser
from oslo_config import sources
# Absolute import to avoid circular import in Python 2.7
import oslo_config.sources._environment as _environment
from oslo_config import types
import stevedore
LOG = logging.getLogger(__name__)
_SOURCE_DRIVER_OPTION_HELP = (
'The name of the driver that can load this '
'configuration source.'
)
class Locations(enum.Enum):
opt_default = (1, False)
set_default = (2, False)
set_override = (3, False)
user = (4, True)
command_line = (5, True)
environment = (6, True)
def __init__(self, num, is_user_controlled):
self.num = num
self.is_user_controlled = is_user_controlled
LocationInfo = collections.namedtuple('LocationInfo', ['location', 'detail'])
class Error(Exception):
"""Base class for cfg exceptions."""
def __init__(self, msg=None):
self.msg = msg
def __str__(self):
return self.msg
class NotInitializedError(Error):
"""Raised if parser is not initialized yet."""
def __str__(self):
return "call expression on parser has not been invoked"
class ArgsAlreadyParsedError(Error):
"""Raised if a CLI opt is registered after parsing."""
def __str__(self):
ret = "arguments already parsed"
if self.msg:
ret += ": " + self.msg
return ret
class NoSuchOptError(Error, AttributeError):
"""Raised if an opt which doesn't exist is referenced."""
def __init__(self, opt_name, group=None):
self.opt_name = opt_name
self.group = group
def __str__(self):
group_name = 'DEFAULT' if self.group is None else self.group.name
return "no such option %s in group [%s]" % (self.opt_name, group_name)
class NoSuchGroupError(Error):
"""Raised if a group which doesn't exist is referenced."""
def __init__(self, group_name):
self.group_name = group_name
def __str__(self):
return "no such group [%s]" % self.group_name
class DuplicateOptError(Error):
"""Raised if multiple opts with the same name are registered."""
def __init__(self, opt_name):
self.opt_name = opt_name
def __str__(self):
return "duplicate option: %s" % self.opt_name
class RequiredOptError(Error):
"""Raised if an option is required but no value is supplied by the user."""
def __init__(self, opt_name, group=None):
self.opt_name = opt_name
self.group = group
def __str__(self):
group_name = 'DEFAULT' if self.group is None else self.group.name
return "value required for option %s in group [%s]" % (self.opt_name,
group_name)
class TemplateSubstitutionError(Error):
"""Raised if an error occurs substituting a variable in an opt value."""
def __str__(self):
return "template substitution error: %s" % self.msg
class ConfigFilesNotFoundError(Error):
"""Raised if one or more config files are not found."""
def __init__(self, config_files):
self.config_files = config_files
def __str__(self):
return ('Failed to find some config files: %s' %
",".join(self.config_files))
class ConfigFilesPermissionDeniedError(Error):
"""Raised if one or more config files are not readable."""
def __init__(self, config_files):
self.config_files = config_files
def __str__(self):
return ('Failed to open some config files: %s' %
",".join(self.config_files))
class ConfigDirNotFoundError(Error):
"""Raised if the requested config-dir is not found."""
def __init__(self, config_dir):
self.config_dir = config_dir
def __str__(self):
return ('Failed to read config file directory: %s' % self.config_dir)
class ConfigFileParseError(Error):
"""Raised if there is an error parsing a config file."""
def __init__(self, config_file, msg):
self.config_file = config_file
self.msg = msg
def __str__(self):
return 'Failed to parse %s: %s' % (self.config_file, self.msg)
class ConfigSourceValueError(Error, ValueError):
"""Raised if a config source value does not match its opt type."""
pass
class ConfigFileValueError(ConfigSourceValueError):
"""Raised if a config file value does not match its opt type."""
pass
class DefaultValueError(Error, ValueError):
"""Raised if a default config type does not fit the opt type."""
def _fixpath(p):
"""Apply tilde expansion and absolutization to a path."""
return os.path.abspath(os.path.expanduser(p))
def _get_config_dirs(project=None):
"""Return a list of directories where config files may be located.
:param project: an optional project name
If a project is specified, following directories are returned::
~/.${project}/
~/
/etc/${project}/
/etc/
If a project is specified and installed from a snap package, following
directories are also returned:
${SNAP_COMMON}/etc/${project}
${SNAP}/etc/${project}
Otherwise, if project is not specified, these directories are returned:
~/
/etc/
"""
snap = os.environ.get('SNAP')
snap_c = os.environ.get('SNAP_COMMON')
cfg_dirs = [
_fixpath(os.path.join('~', '.' + project)) if project else None,
_fixpath('~'),
os.path.join('/etc', project) if project else None,
'/etc',
os.path.join(snap_c, "etc", project) if snap_c and project else None,
os.path.join(snap, "etc", project) if snap and project else None,
]
return [x for x in cfg_dirs if x]
def _search_dirs(dirs, basename, extension=""):
"""Search a list of directories for a given filename or directory name.
Iterator over the supplied directories, returning the first file
found with the supplied name and extension.
:param dirs: a list of directories
:param basename: the filename or directory name, for example 'glance-api'
:param extension: the file extension, for example '.conf'
:returns: the path to a matching file or directory, or None
"""
for d in dirs:
path = os.path.join(d, '%s%s' % (basename, extension))
if os.path.exists(path):
return path
def _find_config_files(project, prog, extension):
if prog is None:
prog = os.path.basename(sys.argv[0])
if prog.endswith(".py"):
prog = prog[:-3]
cfg_dirs = _get_config_dirs(project)
config_files = (_search_dirs(cfg_dirs, p, extension)
for p in [project, prog] if p)
return [x for x in config_files if x]
def find_config_files(project=None, prog=None, extension='.conf'):
"""Return a list of default configuration files.
:param project: an optional project name
:param prog: the program name, defaulting to the basename of
sys.argv[0], without extension .py
:param extension: the type of the config file
We default to two config files: [${project}.conf, ${prog}.conf]
And we look for those config files in the following directories::
~/.${project}/
~/
/etc/${project}/
/etc/
${SNAP_COMMON}/etc/${project}
${SNAP}/etc/${project}
We return an absolute path for (at most) one of each the default config
files, for the topmost directory it exists in.
For example, if project=foo, prog=bar and /etc/foo/foo.conf, /etc/bar.conf
and ~/.foo/bar.conf all exist, then we return ['/etc/foo/foo.conf',
'~/.foo/bar.conf']
If no project name is supplied, we only look for ${prog}.conf.
"""
return _find_config_files(project, prog, extension)
def find_config_dirs(project=None, prog=None, extension='.conf.d'):
"""Return a list of default configuration dirs.
:param project: an optional project name
:param prog: the program name, defaulting to the basename of
sys.argv[0], without extension .py
:param extension: the type of the config directory. Defaults to '.conf.d'
We default to two config dirs: [${project}.conf.d/, ${prog}.conf.d/].
If no project name is supplied, we only look for ${prog.conf.d/}.
And we look for those config dirs in the following directories::
~/.${project}/
~/
/etc/${project}/
/etc/
${SNAP_COMMON}/etc/${project}
${SNAP}/etc/${project}
We return an absolute path for each of the two config dirs,
in the first place we find it (iff we find it).
For example, if project=foo, prog=bar and /etc/foo/foo.conf.d/,
/etc/bar.conf.d/ and ~/.foo/bar.conf.d/ all exist, then we return
['/etc/foo/foo.conf.d/', '~/.foo/bar.conf.d/']
"""
return _find_config_files(project, prog, extension)
def _is_opt_registered(opts, opt):
"""Check whether an opt with the same name is already registered.
The same opt may be registered multiple times, with only the first
registration having any effect. However, it is an error to attempt
to register a different opt with the same name.
:param opts: the set of opts already registered
:param opt: the opt to be registered
:returns: True if the opt was previously registered, False otherwise
:raises: DuplicateOptError if a naming conflict is detected
"""
if opt.dest in opts:
if opts[opt.dest]['opt'] != opt:
raise DuplicateOptError(opt.name)
return True
else:
return False
_show_caller_details = bool(os.environ.get(
'OSLO_CONFIG_SHOW_CODE_LOCATIONS'))
def _get_caller_detail(n=2):
"""Return a string describing where this is being called from.
:param n: Number of steps up the stack to look. Defaults to ``2``.
:type n: int
:returns: str
"""
if not _show_caller_details:
return None
s = inspect.stack()[:n + 1]
try:
frame = s[n]
try:
return frame[1]
# WARNING(dhellmann): Using frame.lineno to include the
# line number in the return value causes some sort of
# memory or stack corruption that manifests in values not
# being cleaned up in the cfgfilter tests.
# return '%s:%s' % (frame[1], frame[2])
finally:
del frame
finally:
del s
def set_defaults(opts, **kwargs):
for opt in opts:
if opt.dest in kwargs:
opt.default = kwargs[opt.dest]
opt._set_location = LocationInfo(Locations.set_default,
_get_caller_detail())
def _normalize_group_name(group_name):
if group_name == 'DEFAULT':
return group_name
return group_name.lower()
def _report_deprecation(format_str, format_dict):
"""Report use of a deprecated option
Uses versionutils from oslo.log if it is available. If not, logs
a simple warning message.
:param format_str: The message to use for the report
:param format_dict: A dict containing keys for any parameters in format_str
"""
if oslo_log:
# We can't import versionutils at the module level because of circular
# imports. Importing just oslo_log at the module level and
# versionutils locally allows us to unit test this and still avoid the
# circular problem.
from oslo_log import versionutils
versionutils.report_deprecated_feature(LOG, format_str,
format_dict)
else:
LOG.warning(format_str, format_dict)
@functools.total_ordering
class Opt(object):
"""Base class for all configuration options.
The only required parameter is the option's name. However, it is
common to also supply a default and help string for all options.
:param name: the option's name
:param type: the option's type. Must be a callable object that takes string
and returns converted and validated value
:param dest: the name of the corresponding :class:`.ConfigOpts` property
:param short: a single character CLI option name
:param default: the default value of the option
:param positional: True if the option is a positional CLI argument
:param metavar: the option argument to show in --help
:param help: an explanation of how the option is used
:param secret: true if the value should be obfuscated in log output
:param required: true if a value must be supplied for this option
:param deprecated_name: deprecated name option. Acts like an alias
:param deprecated_group: the group containing a deprecated alias
:param deprecated_opts: list of :class:`.DeprecatedOpt`
:param sample_default: a default string for sample config files
:param deprecated_for_removal: indicates whether this opt is planned for
removal in a future release
:param deprecated_reason: indicates why this opt is planned for removal in
a future release. Silently ignored if
deprecated_for_removal is False
:param deprecated_since: indicates which release this opt was deprecated
in. Accepts any string, though valid version
strings are encouraged. Silently ignored if
deprecated_for_removal is False
:param mutable: True if this option may be reloaded
:param advanced: a bool True/False value if this option has advanced usage
and is not normally used by the majority of users
An Opt object has no public methods, but has a number of public properties:
.. py:attribute:: name
the name of the option, which may include hyphens
.. py:attribute:: type
a callable object that takes string and returns converted and
validated value. Default types are available from
:class:`oslo_config.types`
.. py:attribute:: dest
the (hyphen-less) :class:`.ConfigOpts` property which contains the
option value
.. py:attribute:: short
a single character CLI option name
.. py:attribute:: default
the default value of the option
.. py:attribute:: sample_default
a sample default value string to include in sample config files
.. py:attribute:: positional
True if the option is a positional CLI argument
.. py:attribute:: metavar
the name shown as the argument to a CLI option in --help output
.. py:attribute:: help
a string explaining how the option's value is used
.. py:attribute:: advanced
in sample files, a bool value indicating the option is advanced
.. versionchanged:: 1.2
Added *deprecated_opts* parameter.
.. versionchanged:: 1.4
Added *sample_default* parameter.
.. versionchanged:: 1.9
Added *deprecated_for_removal* parameter.
.. versionchanged:: 2.7
An exception is now raised if the default value has the wrong type.
.. versionchanged:: 3.2
Added *deprecated_reason* parameter.
.. versionchanged:: 3.5
Added *mutable* parameter.
.. versionchanged:: 3.12
Added *deprecated_since* parameter.
.. versionchanged:: 3.15
Added *advanced* parameter and attribute.
"""
multi = False
def __init__(self, name, type=None, dest=None, short=None,
default=None, positional=False, metavar=None, help=None,
secret=False, required=False,
deprecated_name=None, deprecated_group=None,
deprecated_opts=None, sample_default=None,
deprecated_for_removal=False, deprecated_reason=None,
deprecated_since=None, mutable=False, advanced=False):
if name.startswith('_'):
raise ValueError('illegal name %s with prefix _' % (name,))
self.name = name
if type is None:
type = types.String()
if not callable(type):
raise TypeError('type must be callable')
self.type = type
if dest is None:
self.dest = self.name.replace('-', '_')
else:
self.dest = dest
self.short = short
self.default = default
self.sample_default = sample_default
self.positional = positional
self.metavar = metavar
self.help = help
self.secret = secret
self.required = required
self.deprecated_for_removal = deprecated_for_removal
self.deprecated_reason = deprecated_reason
self.deprecated_since = deprecated_since
self._logged_deprecation = False
if self.__class__ is Opt:
stack_depth = 2 # someone instantiated Opt directly
else:
stack_depth = 3 # skip the call to the child class constructor
self._set_location = LocationInfo(
Locations.opt_default,
_get_caller_detail(stack_depth),
)
self.deprecated_opts = copy.deepcopy(deprecated_opts) or []
for o in self.deprecated_opts:
if '-' in o.name:
self.deprecated_opts.append(DeprecatedOpt(
o.name.replace('-', '_'),
group=o.group))
if deprecated_name is not None or deprecated_group is not None:
self.deprecated_opts.append(DeprecatedOpt(deprecated_name,
group=deprecated_group))
if deprecated_name and '-' in deprecated_name:
self.deprecated_opts.append(DeprecatedOpt(
deprecated_name.replace('-', '_'),
group=deprecated_group))
self._check_default()
self.mutable = mutable
self.advanced = advanced
def _default_is_ref(self):
"""Check if default is a reference to another var."""
if isinstance(self.default, six.string_types):
tmpl = self.default.replace(r'\$', '').replace('$$', '')
return '$' in tmpl
return False
def _check_default(self):
if (self.default is not None
and not self._default_is_ref()):
try:
self.type(self.default)
except Exception:
raise DefaultValueError("Error processing default value "
"%(default)s for Opt type of %(opt)s."
% {'default': self.default,
'opt': self.type})
def _vars_for_cmp(self):
# NOTE(dhellmann): Get the instance variables of this Opt and
# then make a new dictionary so we can modify the contents
# before returning it without removing any attributes of the
# object.
v = dict(vars(self))
# NOTE(dhellmann): Ignore the location where the option is
# defined when comparing them. Ideally we could use this to
# detect duplicate settings in code bases, but as long as the
# options match otherwise they should be safe.
if '_set_location' in v:
del v['_set_location']
return v
def __ne__(self, another):
return self._vars_for_cmp() != another._vars_for_cmp()
def __eq__(self, another):
return self._vars_for_cmp() == another._vars_for_cmp()
__hash__ = object.__hash__
def _get_from_namespace(self, namespace, group_name):
"""Retrieves the option value from a _Namespace object.
:param namespace: a _Namespace object
:param group_name: a group name
"""
names = [(group_name, self.dest)]
current_name = (group_name, self.name)
for opt in self.deprecated_opts:
dname, dgroup = opt.name, opt.group
if dname or dgroup:
names.append((dgroup if dgroup else group_name,
dname if dname else self.dest))
value, loc = namespace._get_value(
names, multi=self.multi,
positional=self.positional, current_name=current_name)
# The previous line will raise a KeyError if no value is set in the
# config file, so we'll only log deprecations for set options.
if self.deprecated_for_removal and not self._logged_deprecation:
self._logged_deprecation = True
pretty_group = group_name or 'DEFAULT'
if self.deprecated_reason:
pretty_reason = ' ({})'.format(self.deprecated_reason)
else:
pretty_reason = ''
format_str = ('Option "%(option)s" from group "%(group)s" is '
'deprecated for removal%(reason)s. Its value may '
'be silently ignored in the future.')
format_dict = {'option': self.dest,
'group': pretty_group,
'reason': pretty_reason}
_report_deprecation(format_str, format_dict)
return (value, loc)
def _add_to_cli(self, parser, group=None):
"""Makes the option available in the command line interface.
This is the method ConfigOpts uses to add the opt to the CLI interface
as appropriate for the opt type. Some opt types may extend this method,
others may just extend the helper methods it uses.
:param parser: the CLI option parser
:param group: an optional OptGroup object
"""
container = self._get_argparse_container(parser, group)
kwargs = self._get_argparse_kwargs(group)
prefix = self._get_argparse_prefix('', group.name if group else None)
deprecated_names = []
for opt in self.deprecated_opts:
deprecated_name = self._get_deprecated_cli_name(opt.name,
opt.group)
if deprecated_name is not None:
deprecated_names.append(deprecated_name)
self._add_to_argparse(parser, container, self.name, self.short,
kwargs, prefix,
self.positional, deprecated_names)
def _add_to_argparse(self, parser, container, name, short, kwargs,
prefix='', positional=False, deprecated_names=None):
"""Add an option to an argparse parser or group.
:param container: an argparse._ArgumentGroup object
:param name: the opt name
:param short: the short opt name
:param kwargs: the keyword arguments for add_argument()
:param prefix: an optional prefix to prepend to the opt name
:param positional: whether the option is a positional CLI argument
:param deprecated_names: list of deprecated option names
"""
def hyphen(arg):
return arg if not positional else ''
args = [hyphen('--') + prefix + name]
if short:
args.append(hyphen('-') + short)
for deprecated_name in deprecated_names:
args.append(hyphen('--') + deprecated_name)
parser.add_parser_argument(container, *args, **kwargs)
def _get_argparse_container(self, parser, group):
"""Returns an argparse._ArgumentGroup.
:param parser: an argparse.ArgumentParser
:param group: an (optional) OptGroup object
:returns: an argparse._ArgumentGroup if group is given, else parser
"""
if group is not None:
return group._get_argparse_group(parser)
else:
return parser
def _get_argparse_kwargs(self, group, **kwargs):
r"""Build a dict of keyword arguments for argparse's add_argument().
Most opt types extend this method to customize the behaviour of the
options added to argparse.
:param group: an optional group
:param \*\*kwargs: optional keyword arguments to add to
:returns: a dict of keyword arguments
"""
if not self.positional:
dest = self.dest
if group is not None:
dest = group.name + '_' + dest
kwargs['dest'] = dest
else:
kwargs['nargs'] = '?'
kwargs.update({'default': None,
'metavar': self.metavar,
'help': self.help, })
return kwargs
def _get_argparse_prefix(self, prefix, group_name):
"""Build a prefix for the CLI option name, if required.
CLI options in a group are prefixed with the group's name in order
to avoid conflicts between similarly named options in different
groups.
:param prefix: an existing prefix to append to (for example 'no' or '')
:param group_name: an optional group name
:returns: a CLI option prefix including the group name, if appropriate
"""
if group_name is not None:
return group_name + '-' + prefix
else:
return prefix
def _get_deprecated_cli_name(self, dname, dgroup, prefix=''):
"""Build a CLi arg name for deprecated options.
Either a deprecated name or a deprecated group or both or
neither can be supplied:
dname, dgroup -> dgroup + '-' + dname
dname -> dname
dgroup -> dgroup + '-' + self.name
neither -> None
:param dname: a deprecated name, which can be None
:param dgroup: a deprecated group, which can be None
:param prefix: an prefix to append to (for example 'no' or '')
:returns: a CLI argument name
"""
if dgroup == 'DEFAULT':
dgroup = None
if dname is None and dgroup is None:
return None
if dname is None:
dname = self.name
return self._get_argparse_prefix(prefix, dgroup) + dname
def __lt__(self, another):
return hash(self) < hash(another)
class DeprecatedOpt(object):
"""Represents a Deprecated option.
Here's how you can use it::
oldopts = [cfg.DeprecatedOpt('oldopt1', group='group1'),
cfg.DeprecatedOpt('oldopt2', group='group2')]
cfg.CONF.register_group(cfg.OptGroup('group1'))
cfg.CONF.register_opt(cfg.StrOpt('newopt', deprecated_opts=oldopts),
group='group1')
For options which have a single value (like in the example above),
if the new option is present ("[group1]/newopt" above), it will override
any deprecated options present ("[group1]/oldopt1" and "[group2]/oldopt2"
above).
If no group is specified for a DeprecatedOpt option (i.e. the group is
None), lookup will happen within the same group the new option is in.
For example, if no group was specified for the second option 'oldopt2' in
oldopts list::
oldopts = [cfg.DeprecatedOpt('oldopt1', group='group1'),
cfg.DeprecatedOpt('oldopt2')]
cfg.CONF.register_group(cfg.OptGroup('group1'))
cfg.CONF.register_opt(cfg.StrOpt('newopt', deprecated_opts=oldopts),
group='group1')
then lookup for that option will happen in group 'group1'.
If the new option is not present and multiple deprecated options are
present, the option corresponding to the first element of deprecated_opts
will be chosen.
Multi-value options will return all new and deprecated
options. So if we have a multi-value option "[group1]/opt1" whose
deprecated option is "[group2]/opt2", and the conf file has both these
options specified like so::
[group1]
opt1=val10,val11
[group2]
opt2=val21,val22
Then the value of "[group1]/opt1" will be ['val10', 'val11', 'val21',
'val22'].
.. versionadded:: 1.2
"""
def __init__(self, name, group=None):
"""Constructs an DeprecatedOpt object.
:param name: the name of the option
:param group: the group of the option
"""
self.name = name
self.group = group
def __key(self):
return (self.name, self.group)
def __eq__(self, other):
return self.__key() == other.__key()
def __hash__(self):
return hash(self.__key())
class StrOpt(Opt):
r"""Option with String type
Option with ``type`` :class:`oslo_config.types.String`
:param name: the option's name
:param choices: Optional sequence of either valid values or tuples of valid
values with descriptions.
:param quotes: If True and string is enclosed with single or double
quotes, will strip those quotes.
:param regex: Optional regular expression (string or compiled
regex) that the value must match on an unanchored
search.
:param ignore_case: If True case differences (uppercase vs. lowercase)
between 'choices' or 'regex' will be ignored.
:param max_length: If positive integer, the value must be less than or
equal to this parameter.
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
.. versionchanged:: 2.7
Added *quotes* parameter
.. versionchanged:: 2.7
Added *regex* parameter
.. versionchanged:: 2.7
Added *ignore_case* parameter
.. versionchanged:: 2.7
Added *max_length* parameter
.. versionchanged:: 5.2
The *choices* parameter will now accept a sequence of tuples, where each
tuple is of form (*choice*, *description*)
"""
def __init__(self, name, choices=None, quotes=None,
regex=None, ignore_case=False, max_length=None, **kwargs):
super(StrOpt, self).__init__(name,
type=types.String(
choices=choices,
quotes=quotes,
regex=regex,
ignore_case=ignore_case,
max_length=max_length),
**kwargs)
def _get_choice_text(self, choice):
if choice is None:
return '<None>'
elif choice == '':
return "''"
return six.text_type(choice)
def _get_argparse_kwargs(self, group, **kwargs):
"""Extends the base argparse keyword dict for the config dir option."""
kwargs = super(StrOpt, self)._get_argparse_kwargs(group)
if getattr(self.type, 'choices', None):
choices_text = ', '.join([self._get_choice_text(choice)
for choice in self.type.choices])
if kwargs['help'] is None:
kwargs['help'] = ''
kwargs['help'].rstrip('\n')
kwargs['help'] += '\n Allowed values: %s\n' % choices_text
return kwargs
class BoolOpt(Opt):
r"""Boolean options.
Bool opts are set to True or False on the command line using --optname or
--nooptname respectively.
In config files, boolean values are cast with Boolean type.
:param name: the option's name
:param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt`
"""
def __init__(self, name, **kwargs):
if 'positional' in kwargs:
raise ValueError('positional boolean args not supported')
super(BoolOpt, self).__init__(name, type=types.Boolean(), **kwargs)
def _add_to_cli(self, parser, group=None):
"""Extends the base class method to add the --nooptname option."""
super(BoolOpt, self)._add_to_cli(parser, group)
self._add_inverse_to_argparse(parser, group)
def _add_inverse_to_argparse(self, parser, group):
"""Add the --nooptname option to the option parser."""
container = self._get_argparse_container(parser, group)
kwargs = self._get_argparse_kwargs(group, action='store_false')
prefix = self._get_argparse_prefix('no', group.name if group else None)
deprecated_names = []
for opt in self.deprecated_opts:
deprecated_name = self._get_deprecated_cli_name(opt.name,
opt.group,
prefix='no')
if deprecated_name is not None:
deprecated_names.append(deprecated_name)
kwargs["help"] = "The inverse of --" + self.name
self._add_to_argparse(parser, container, self.name, None, kwargs,
prefix, self.positional, deprecated_names)
def _get_argparse_kwargs(self, group, action='store_true', **kwargs):
"""Extends the base argparse keyword dict for boolean options."""
kwargs = super(BoolOpt, self)._get_argparse_kwargs(group, **kwargs)
# type has no effect for BoolOpt, it only matters for
# values that came from config files
if 'type' in kwargs:
del kwargs['type']
# metavar has no effect for BoolOpt
if 'metavar' in kwargs:
del kwargs['metavar']
kwargs['action'] = action