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
|
# Copyright (c) 2014 Hewlett-Packard Development Company, L.P.
#
# 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.
import argparse
import sys
import typing as ty
from openstack.config.loader import OpenStackConfig # noqa
if ty.TYPE_CHECKING:
from openstack.config import cloud_region
__all__ = [
'OpenStackConfig',
'cloud_region',
'get_cloud_region',
]
# TODO(stephenfin): Expand kwargs once we've typed OpenstackConfig.get_one
def get_cloud_region(
service_key: str | None = None,
options: argparse.ArgumentParser | None = None,
app_name: str | None = None,
app_version: str | None = None,
load_yaml_config: bool = True,
load_envvars: bool = True,
**kwargs: ty.Any,
) -> 'cloud_region.CloudRegion':
"""Retrieve a single CloudRegion and merge additional options
:param service_key: Service this argparse should be specialized for, if
known. This will be used as the default value for service_type.
:param options: Parser to attach additional options to
:param app_name: Name of the application to be added to User Agent.
:param app_version: Version of the application to be added to User Agent.
:param load_yaml_config: Whether to load configuration from clouds.yaml and
related configuration files.
:param load_envvars: Whether to load configuration from environment
variables
:returns: A populated
:class:`~openstack.config.cloud.cloud_region.CloudRegion` object.
"""
config = OpenStackConfig(
load_yaml_config=load_yaml_config,
load_envvars=load_envvars,
app_name=app_name,
app_version=app_version,
)
if options:
service_keys = [service_key] if service_key is not None else []
config.register_argparse_arguments(options, sys.argv, service_keys)
parsed_options, _ = options.parse_known_args(sys.argv)
else:
parsed_options = None
return config.get_one(argparse=parsed_options, **kwargs)
|
