summaryrefslogtreecommitdiff
path: root/cloudinit/importer.py
blob: f84ff4dab076b19d43eafd9a9ae0fad670b3eace (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
# Copyright (C) 2012 Canonical Ltd.
# Copyright (C) 2012 Hewlett-Packard Development Company, L.P.
# Copyright (C) 2012 Yahoo! Inc.
#
# Author: Scott Moser <scott.moser@canonical.com>
# Author: Juerg Haefliger <juerg.haefliger@hp.com>
# Author: Joshua Harlow <harlowja@yahoo-inc.com>
#
# This file is part of cloud-init. See LICENSE file for license information.

import sys
import typing

# annotations add value for development, but don't break old versions
# pyver: 3.5 -> 3.8
# pylint: disable=E1101
if sys.version_info >= (3, 8) and hasattr(typing, "TypeDict"):
    MetaSchema = typing.TypedDict(
        "MetaSchema",
        {
            "name": str,
            "id": str,
            "title": str,
            "description": str,
            "distros": typing.List[str],
            "examples": typing.List[str],
            "frequency": str,
        },
    )
else:
    MetaSchema = dict
# pylint: enable=E1101


def import_module(module_name):
    __import__(module_name)
    return sys.modules[module_name]


def find_module(base_name: str, search_paths, required_attrs=None) -> tuple:
    """Finds and imports specified modules"""
    if not required_attrs:
        required_attrs = []
    # NOTE(harlowja): translate the search paths to include the base name.
    lookup_paths = []
    for path in search_paths:
        real_path = []
        if path:
            real_path.extend(path.split("."))
        real_path.append(base_name)
        full_path = ".".join(real_path)
        lookup_paths.append(full_path)
    found_paths = []
    for full_path in lookup_paths:
        mod = None
        try:
            mod = import_module(full_path)
        except ImportError:
            pass
        if not mod:
            continue
        found_attrs = 0
        for attr in required_attrs:
            if hasattr(mod, attr):
                found_attrs += 1
        if found_attrs == len(required_attrs):
            found_paths.append(full_path)
    return (found_paths, lookup_paths)


# vi: ts=4 expandtab