Source code for traits.util.import_symbol

# (C) Copyright 2005-2022 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!

""" A function to import symbols. """

from importlib import import_module

from traits.trait_base import xgetattr


[docs]def import_symbol(symbol_path): """ Import the symbol defined by the specified symbol path. Examples -------- import_symbol('tarfile:TarFile') -> TarFile import_symbol('tarfile:TarFile.open') -> TarFile.open To allow compatibility with old-school traits symbol names we also allow all-dotted paths, but in this case you can only import top-level names from the module. import_symbol('tarfile.TarFile') -> TarFile """ if ":" in symbol_path: module_name, symbol_name = symbol_path.split(":") module = import_module(module_name) symbol = xgetattr(module, symbol_name) else: components = symbol_path.split(".") module_name = ".".join(components[:-1]) symbol_name = components[-1] module = import_module(module_name) symbol = getattr(module, symbol_name) return symbol