"""
Copyright (c) 2010-2018 CNRS / Centre de Recherche Astrophysique de Lyon
Copyright (c) 2015-2019 Simon Conseil <simon.conseil@univ-lyon1.fr>
Copyright (c) 2016 Laure Piqueras <laure.piqueras@univ-lyon1.fr>
Copyright (c) 2018 David Carton <cartondj@gmail.com>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
from collections import OrderedDict
from collections.abc import MutableMapping
import functools
import inspect
import logging
import numpy as np
import os
import warnings
from astropy.units import UnitsWarning
from contextlib import contextmanager
from functools import wraps
from time import time
__all__ = ('MpdafWarning', 'MpdafUnitsWarning', 'deprecated', 'chdir',
'timeit', 'timer', 'broadcast_to_cube', 'LowercaseOrderedDict',
'all_subclasses', 'isiter', 'isnotebook', 'progressbar')
# NOTE(kgriffs): We don't want our deprecations to be ignored by default,
# so create our own type.
[docs]class MpdafWarning(UserWarning):
pass
[docs]class MpdafUnitsWarning(UnitsWarning):
pass
[docs]def deprecated(instructions):
"""Flags a method as deprecated.
Args:
instructions: A human-friendly string of instructions, such
as: 'Please migrate to add_proxy() ASAP.'
"""
def decorator(func):
"""This is a decorator which can be used to mark functions as
deprecated.
It will result in a warning being emitted when the function is
used.
"""
@functools.wraps(func)
def wrapper(*args, **kwargs):
message = 'Call to deprecated function `{}`. {}'.format(
func.__name__,
instructions)
frame = inspect.currentframe().f_back
warnings.warn_explicit(message,
category=MpdafWarning,
filename=inspect.getfile(frame.f_code),
lineno=frame.f_lineno)
return func(*args, **kwargs)
return wrapper
return decorator
[docs]@contextmanager
def chdir(dirname):
"""Context manager to change the current working directory."""
curdir = os.getcwd()
try:
os.chdir(dirname)
yield
finally:
os.chdir(curdir)
[docs]def timeit(f):
"""Decorator which prints the execution time of a function."""
@wraps(f)
def timed(*args, **kw):
logger = logging.getLogger(__name__)
t0 = time()
result = f(*args, **kw)
logger.info('%r (%r, %r) %2.2f sec', f.__name__, args, kw, time() - t0)
return result
return timed
[docs]@contextmanager
def timer():
"""Context manager which prints the execution time."""
logger = logging.getLogger(__name__)
start = time()
yield
logger.info('Request took %.03f sec.', time() - start)
[docs]def broadcast_to_cube(arr, shape):
"""Broadcast an array (image or spectrum to a cube."""
assert len(shape) == 3
excmsg = 'Incorrect dimensions for the weights (%s) (it must be (%s))'
if arr.ndim == 3 and arr.shape != shape:
raise ValueError(excmsg % (arr.shape, shape))
elif arr.ndim == 2 and arr.shape != shape[1:]:
raise ValueError(excmsg % (arr.shape, shape[1:]))
elif arr.ndim == 1:
if arr.shape[0] != shape[0]:
raise ValueError(excmsg % (arr.shape[0], shape[0]))
arr = arr[:, np.newaxis, np.newaxis]
return np.broadcast_to(arr, shape)
[docs]def all_subclasses(cls):
"""Return a set of subclasses of a given cls."""
return set(cls.__subclasses__()).union(
[s for c in cls.__subclasses__() for s in all_subclasses(c)])
[docs]def isiter(val):
"""Return True is val is iterable."""
try:
iter(val)
except TypeError:
return False
else:
return True
[docs]def isnotebook(): # pragma: no cover
"""Detect if running inside a jupyter notebook."""
try:
shell = get_ipython().__class__.__name__
if shell == 'ZMQInteractiveShell':
return True # Jupyter notebook or qtconsole
elif shell == 'TerminalInteractiveShell':
return False # Terminal running IPython
else:
return False # Other type (?)
except NameError:
return False # Probably standard Python interpreter
[docs]def progressbar(*args, **kwargs):
"""Wrapper for tqdm progress bar, with notebook detection."""
from tqdm import tqdm, tqdm_notebook
func = tqdm_notebook if isnotebook() else tqdm
return func(*args, **kwargs)
# Here we inherit unnecessarily from OrderedDict.
# This is because when merging astropy.table.Table() objects, an explicit
# check for the metadata object is a <dict> instance
[docs]class LowercaseOrderedDict(MutableMapping, OrderedDict):
"""Ordered dictionary where all strings keys are case insensitive.
i.e. keys such as 'abc', 'ABC', 'Abc' all map to the same value.
This can be useful for mimicking the storage of FITS headers.
"""
def __init__(self, *args):
self._d = OrderedDict()
self.update(*args)
@staticmethod
def _convert(key):
if isinstance(key, str):
return key.lower()
else:
return key
def __getitem__(self, key):
return self._d[self._convert(key)]
def __setitem__(self, key, value):
self._d[self._convert(key)] = value
def __delitem__(self, key):
del self._d[self._convert(key)]
def __iter__(self):
return iter(self._d)
def __len__(self):
return len(self._d)
def __repr__(self):
return "{}({})".format(self.__class__, [i for i in self._d.items()])
def __str__(self):
return "{}({})".format(self.__class__, [i for i in self._d.items()])
[docs] def popitem(self, last=True):
# MutableMapping pops the first item, whereas OrderedDict pops the last
# We implement the latter.
return self._d.popitem(last)
[docs] def copy(self):
return self.__class__(self)