# This file is part of PyOP2
#
# PyOP2 is Copyright (c) 2012, Imperial College London and
# others. Please see the AUTHORS file in the main source directory for
# a full list of copyright holders. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * 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.
# * The name of Imperial College London or that of other
# contributors may not 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 CONTRIBUTERS
# ''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 HOLDERS 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.
"""Common utility classes/functions."""
import argparse
import sys
import numpy as np
[docs]
def as_tuple(item, type=None, length=None, allow_none=False):
# Empty list if we get passed None
if item is None:
t = ()
else:
# Convert iterable to tuple...
try:
t = tuple(item)
# ... or create a list of a single item
except (TypeError, NotImplementedError):
t = (item,) * (length or 1)
return t
[docs]
def as_type(obj, typ):
"""Return obj if it is of dtype typ, otherwise return a copy type-cast to
typ."""
# Assume it's a NumPy data type
try:
return obj if obj.dtype == typ else obj.astype(typ)
except AttributeError:
if isinstance(obj, int):
return np.int64(obj).astype(typ)
elif isinstance(obj, float):
return np.float64(obj).astype(typ)
else:
raise TypeError("Invalid type %s" % type(obj))
[docs]
def tuplify(xs):
"""Turn a data structure into a tuple tree."""
try:
return tuple(tuplify(x) for x in xs)
except TypeError:
return xs
[docs]
def align(bytes, alignment=16):
"""Align BYTES to a multiple of ALIGNMENT"""
return ((bytes + alignment - 1) // alignment) * alignment
[docs]
def flatten(iterable):
"""Flatten a given nested iterable."""
return (x for e in iterable for x in e)
[docs]
def parser(description=None, group=False):
"""Create default argparse.ArgumentParser parser for pyop2 programs."""
parser = argparse.ArgumentParser(description=description,
add_help=True,
prefix_chars="-",
formatter_class=argparse.RawDescriptionHelpFormatter)
g = parser.add_argument_group(
'pyop2', 'backend configuration options') if group else parser
g.add_argument('-d', '--debug', default=argparse.SUPPRESS,
type=int, choices=list(range(8)),
help='set debug level' if group else 'set pyop2 debug level')
g.add_argument('-l', '--log-level', default='WARN',
choices=['CRITICAL', 'ERROR', 'WARN', 'INFO', 'DEBUG'],
help='set logging level (default=WARN)' if group else
'set pyop2 logging level (default=WARN)')
return parser
[docs]
def parse_args(*args, **kwargs):
"""Return parsed arguments as variables for later use.
ARGS and KWARGS are passed into the parser instantiation.
The only recognised options are `group` and `description`."""
return vars(parser(*args, **kwargs).parse_args())
[docs]
def trim(docstring):
"""Trim a docstring according to `PEP 257
<http://www.python.org/dev/peps/pep-0257/#handling-docstring-indentation>`_."""
if not docstring:
return ''
# Convert tabs to spaces (following the normal Python rules)
# and split into a list of lines:
lines = docstring.expandtabs().splitlines()
# Determine minimum indentation (first line doesn't count):
indent = sys.maxsize
for line in lines[1:]:
stripped = line.lstrip()
if stripped:
indent = min(indent, len(line) - len(stripped))
# Remove indentation (first line is special):
trimmed = [lines[0].strip()]
if indent < sys.maxsize:
for line in lines[1:]:
trimmed.append(line[indent:].rstrip())
# Strip off trailing and leading blank lines:
while trimmed and not trimmed[-1]:
trimmed.pop()
while trimmed and not trimmed[0]:
trimmed.pop(0)
# Return a single string:
return '\n'.join(trimmed)
[docs]
def strip(code):
return '\n'.join([l for l in code.splitlines() if l.strip() and l.strip() != ';'])