File: _utils.py

package info (click to toggle)
python-keystoneauth1 5.12.0-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 2,280 kB
  • sloc: python: 23,506; xml: 285; makefile: 93; sh: 2
file content (47 lines) | stat: -rw-r--r-- 1,505 bytes parent folder | download | duplicates (2)
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
# 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 typing as ty

if ty.TYPE_CHECKING:
    from oslo_config import cfg as _cfg

cfg = None
_NOT_FOUND = object()


def get_oslo_config() -> '_cfg':
    """Runtime load the oslo.config object.

    In performance optimization of openstackclient it was determined that even
    optimistically loading oslo.config if available had a performance cost.
    Given that we used to only raise the ImportError when the function was
    called also attempt to do the import to do everything at runtime.
    """
    global cfg

    # First Call
    if not cfg:
        try:
            from oslo_config import cfg
        except ImportError:
            cfg = _NOT_FOUND

    if cfg is _NOT_FOUND:
        raise ImportError(
            "oslo.config is not an automatic dependency of "
            "keystoneauth. If you wish to use oslo.config "
            "you need to import it into your application's "
            "requirements file. "
        )

    return cfg