104 lines
3.2 KiB
Python
104 lines
3.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# 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 importlib
|
|
import pkgutil
|
|
import sys
|
|
|
|
import pbr.version
|
|
import six
|
|
|
|
this_name = __name__
|
|
this_lib = sys.modules[this_name]
|
|
|
|
__version__ = pbr.version.VersionInfo(this_name).version_string()
|
|
|
|
# Any user-specified feature/trait is prefixed with the custom namespace
|
|
CUSTOM_NAMESPACE = 'CUSTOM_'
|
|
|
|
|
|
def symbolize(mod_name, name):
|
|
"""Given a reference to a Python module object and a short string name for
|
|
a trait, registers a symbol in the module that corresponds to the full
|
|
namespaced trait name.
|
|
"""
|
|
leaf_mod = sys.modules[mod_name]
|
|
value_base = '_'.join([m.upper() for m in mod_name.split('.')[1:]])
|
|
value = value_base + '_' + name.upper()
|
|
setattr(this_lib, value, value) # os_traits.HW_CPU_X86_SSE
|
|
setattr(leaf_mod, name.upper(), value) # os_traits.hw.cpu.x86.SSE
|
|
|
|
|
|
def import_submodules(package, recursive=True):
|
|
"""Import all submodules of a module, recursively, including subpackages
|
|
|
|
:param package: package (name or actual module)
|
|
:type package: str | module
|
|
:rtype: dict[str, types.ModuleType]
|
|
"""
|
|
if isinstance(package, str):
|
|
package = importlib.import_module(package)
|
|
for loader, name, is_pkg in pkgutil.walk_packages(package.__path__):
|
|
full_name = package.__name__ + '.' + name
|
|
test_dir = "%s.tests" % this_name
|
|
if test_dir in full_name:
|
|
continue
|
|
imported = importlib.import_module(full_name)
|
|
for prop in getattr(imported, "TRAITS", []):
|
|
symbolize(full_name, prop)
|
|
if recursive and is_pkg:
|
|
import_submodules(full_name)
|
|
|
|
|
|
# This is where the names defined in submodules are imported
|
|
import_submodules(sys.modules.get(__name__))
|
|
|
|
|
|
def get_traits(prefix=None):
|
|
"""Returns the trait strings in the os_traits module, optionally filtered
|
|
by a supplied prefix.
|
|
|
|
:param prefix: Optional string prefix to filter by. e.g. 'HW_'
|
|
"""
|
|
prefix = prefix or ""
|
|
return [
|
|
v for k, v in sys.modules[__name__].__dict__.items()
|
|
if isinstance(v, six.string_types) and
|
|
not k.startswith('_') and
|
|
v.startswith(prefix)
|
|
]
|
|
|
|
|
|
def check_traits(traits):
|
|
"""Returns a tuple of two trait string sets, the first set contains valid
|
|
traits, and the second contains others.
|
|
|
|
:param traits: An iterable contains trait strings.
|
|
"""
|
|
trait_set = set(traits)
|
|
valid_trait_set = set(get_traits())
|
|
|
|
valid_traits = trait_set & valid_trait_set
|
|
|
|
return (valid_traits, trait_set - valid_traits)
|
|
|
|
|
|
def is_custom(trait):
|
|
"""Returns True if the trait string represents a custom trait, or False
|
|
otherwise.
|
|
|
|
:param trait: String name of the trait
|
|
"""
|
|
return trait.startswith(CUSTOM_NAMESPACE)
|