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
|
# (C) Copyright 2005-2023 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!
""" Utilities for handling optional import dependencies."""
import contextlib
@contextlib.contextmanager
def optional_import(dependency_name, msg, logger):
""" Context manager for capturing ImportError for a particular optional
dependency. If such an error occurs, it will be silenced and a debug
message will be logged.
Parameters
----------
dependency_name : str
Name of the module that may fail to be imported.
If matched, the ImportError will be silenced
msg : str
Log message to be emitted.
logger : Logger
Logger to use for logging messages.
"""
try:
yield
except ImportError as exception:
if exception.name == dependency_name:
logger.debug(msg, exc_info=True)
else:
raise
|
