Source code for ipypublish.utils

import os
import json
import inspect
import importlib
import re
import pkg_resources

from six import string_types
import ruamel.yaml as yaml

# python 2/3 compatibility
    import pathlib
except ImportError:
    import pathlib2 as pathlib

[docs]def handle_error(msg, err_type, logger, raise_msg=None, log_msg=None): """handle an error, by logging it, then raising an exception""" if raise_msg is None: raise_msg = msg if log_msg is None: log_msg = msg logger.error(log_msg) raise err_type(raise_msg)
[docs]def read_file_from_directory( dir_path, file_name, jtype, logger, interp_ext=False, ext_types=(("json", (".json",)), ("yaml", (".yaml", ".yaml.j2"))), ): """load a file situated in a directory if ``interp_ext=True``: interpret the file extension *via* ``ext_types`` and load file in a suitable manner """ if isinstance(dir_path, string_types): dir_path = pathlib.Path(dir_path) file_path = dir_path.joinpath(file_name) if not file_path.exists(): handle_error( "the {} does not exist: {}".format(jtype, file_path), IOError, logger=logger ) ext_type = None ext_map = {ext: ftype for ftype, exts in ext_types for ext in exts} # Place longer extensions first to keep shorter ones from matching first for ext in sorted(ext_map.keys(), key=len, reverse=True): if file_name.endswith(ext): ext_type = ext_map[ext] if ext_type is not None and interp_ext: with as fobj: try: if ext_type == "json": data = json.load(fobj) elif ext_type == "yaml": data = yaml.safe_load(fobj) else: raise ValueError("extension type not recognised") except Exception as err: handle_error( "failed to read {} ({}): {}".format(jtype, file_path, err), IOError, logger=logger, ) else: with as fobj: data = return data
[docs]def get_module_path(module): """return a directory path to a module""" return pathlib.Path(os.path.dirname(os.path.abspath(inspect.getfile(module))))
[docs]def read_file_from_module( module_path, file_name, jtype, logger, interp_ext=False, ext_types=(("json", (".json")), ("yaml", (".yaml", ".yaml.j2", "yaml.tex.j2"))), ): """load a file situated in a python module if ``interp_ext=True``: interpret the file extension *via* ``ext_type`` and load file in a suitable manner """ try: outline_module = importlib.import_module(module_path) except ModuleNotFoundError: # noqa: F821 handle_error( "module {} containing {} {} not found".format( module_path, jtype, file_name ), ModuleNotFoundError, logger=logger, ) # noqa: F821 return read_file_from_directory( get_module_path(outline_module), file_name, jtype, logger, interp_ext=interp_ext, ext_types=ext_types, )
[docs]def get_valid_filename(s): """ Return the given string converted to a string that can be used for a clean filename. Remove leading and trailing spaces; convert other spaces to underscores; and remove anything that is not an alphanumeric, dash, underscore, or dot. >>> get_valid_filename("john's portrait in 2004.jpg") 'johns_portrait_in_2004.jpg' """ s = str(s).strip().replace(" ", "_") return re.sub(r"(?u)[^-\w.]", "", s)
[docs]def find_entry_point(name, group, logger, preferred=None): """find an entry point by name and group Parameters ---------- name: str name of entry point group: str group of entry point preferred: str if multiple matches are found, prefer one from this module """ entry_points = list(pkg_resources.iter_entry_points(group, name)) if len(entry_points) == 0: handle_error( "The {0} entry point " "{1} could not be found".format(group, name), pkg_resources.ResolutionError, logger, ) elif len(entry_points) != 1: # default to the preferred package oentry_points = [] if preferred: oentry_points = [ ep for ep in entry_points if ep.module_name.startswith(preferred) ] if len(oentry_points) != 1: handle_error( "Multiple {0} plugins found for " "{1}: {2}".format(group, name, entry_points), pkg_resources.ResolutionError, logger, ) "Multiple {0} plugins found for {1}, " "defaulting to the {2} version".format(group, name, preferred) ) entry_point = oentry_points[0] else: entry_point = entry_points[0] return entry_point.load()