"""
This module handles loading and using lookatme_contrib modules
def loads(self, *args, **kwargs) -> Dict:
res = super(self.__class__, self).loads(*args, **kwargs)
if res is None:
raise ValueError("Could not loads")
return res
def load(self, *args, **kwargs) -> Dict:
res = super(self.__class__, self).load(*args, **kwargs)
if res is None:
raise ValueError("Could not load")
return res
Contrib modules are directly used
"""
import functools
from typing import List
import lookatme.ascii_art
import lookatme.prompt
from lookatme.exceptions import IgnoredByContrib
CONTRIB_MODULES = []
[docs]def validate_extension_mod(_ext_name, ext_mod):
"""Validate the extension, returns an array of warnings associated with the
module
"""
res = []
if not hasattr(ext_mod, "user_warnings"):
res.append("'user_warnings' is missing. Extension is not able to "
"provide user warnings.")
else:
res += ext_mod.user_warnings()
return res
[docs]def load_contribs(contrib_names, safe_contribs, ignore_load_failure=False):
"""Load all contrib modules specified by ``contrib_names``. These should
all be namespaced packages under the ``lookatmecontrib`` namespace. E.g.
``lookatmecontrib.calendar`` would be an extension provided by a
contrib module, and would be added to an ``extensions`` list in a slide's
YAML header as ``calendar``.
``safe_contribs`` is a set of contrib names that are manually provided
by the user by the ``-e`` flag or env variable of extensions to auto-load.
"""
if contrib_names is None:
return
errors = []
all_warnings = []
for contrib_name in contrib_names:
module_name = f"lookatme.contrib.{contrib_name}"
try:
mod = __import__(module_name, fromlist=[contrib_name])
except Exception as e:
if ignore_load_failure:
continue
errors.append(str(e))
else:
if contrib_name not in safe_contribs:
ext_warnings = validate_extension_mod(contrib_name, mod)
if len(ext_warnings) > 0:
all_warnings.append((contrib_name, ext_warnings))
CONTRIB_MODULES.append(mod)
_handle_load_errors_warnings(errors, all_warnings)
def _handle_load_errors_warnings(errors: List[str], all_warnings: List[str]):
"""Handle all load errors and warnings from loading contrib modules
"""
if len(errors) > 0:
raise Exception(
"Error loading one or more extensions:\n\n" + "\n".join(errors),
)
if len(all_warnings) == 0:
return
print("\nExtension-provided user warnings:")
for ext_name, ext_warnings in all_warnings:
print("\n {!r}:\n".format(ext_name))
for ext_warning in ext_warnings:
print(" * {}".format(ext_warning))
print("")
if not lookatme.prompt.yes("Continue anyways?"):
exit(1)
[docs]def contrib_first(fn):
"""A decorator that allows contrib modules to override default behavior
of lookatme. E.g., a contrib module may override how a table is displayed
to enable sorting, or enable displaying images rendered with ANSII color
codes and box drawing characters, etc.
Contrib modules may ignore chances to override default behavior by raising
the ``lookatme.contrib.IgnoredByContrib`` exception.
"""
fn_name = fn.__name__
@functools.wraps(fn)
def inner(*args, **kwargs):
for mod in CONTRIB_MODULES:
if not hasattr(mod, fn_name):
continue
try:
return getattr(mod, fn_name)(*args, **kwargs)
except IgnoredByContrib:
pass
return fn(*args, **kwargs)
return inner
[docs]def shutdown_contribs():
"""Call the shutdown function on all contrib modules
"""
for mod in CONTRIB_MODULES:
getattr(mod, "shutdown", lambda: 1)()