<gh_stars>10-100
"""GCL utility functions.

These utility functions are intended for GCL CONSUMERS.
"""
from __future__ import absolute_import

import json
import hashlib
import logging
import sys
from os import path
import time

from . import framework
from . import exceptions


logger = logging.getLogger('gcl')


class LogTime(object):
  def __init__(self, name):
    self.name = name

  def __enter__(self):
    self.start = time.time()
    return self

  def __exit__(self, value, type, tb):
    logger.info('%s, time taken %.1fs', self.name, time.time() - self.start)


class RecursionException(RuntimeError):
  pass


class ExpressionWalker(object):
  """Defines the interface for walk()."""

  def enterTuple(self, tuple, path):
    """Called for every tuple.

    If this returns Falsey, the elements of the tuple will not be recursed over and leaveTuple()
    will not be called. It can also return True, or an object, in which case the walk will be
    resumed using the current or the indicated object, respectively.
    """
    return True

  def leaveTuple(self, tuple, path):
    pass

  def enterList(self, list, path):
    # Backwards compat
    return self.enterTuple(list, path)

  def leaveList(self, list, path):
    # Backwards compat
    return self.leaveTuple(list, path)

  def visitRecursion(self, key_path):
    self.visitError(key_path, RecursionException('recursion'))

  def visitError(self, key_path, ex):
    pass

  def visitScalar(self, key_path, value):
    pass


def get_or_error(tuple, key):
  try:
    return tuple[key]
  except exceptions.EvaluationError as e:
    return e


# Python 2/3 compatibility for iteritems
p6_iteritems = (lambda x: x.iteritems()) if hasattr({}, 'iteritems') else (lambda x: x.items())


def to_python(value, seen=None):
  """Reify values to their Python equivalents.

  Does recursion detection, failing when that happens.
  """
  seen = seen or set()
  if isinstance(value, framework.TupleLike):
    if value.ident in seen:
      raise RecursionException('to_python: infinite recursion while evaluating %r' % value)
    new_seen = seen.union([value.ident])
    return {k: to_python(value[k], seen=new_seen) for k in value.exportable_keys()}
  if isinstance(value, dict):
    return {k: to_python(value[k], seen=seen) for k in value.keys()}
  if isinstance(value, list):
    return [to_python(x, seen=seen) for x in value]
  return value


def walk(value, walker, path=None, seen=None):
  """Walks the _evaluated_ tree of the given GCL tuple.

  The appropriate methods of walker will be invoked for every element in the
  tree.
  """
  seen = seen or set()
  path = path or []

  # Recursion
  if id(value) in seen:
    walker.visitRecursion(path)
    return

  # Error
  if isinstance(value, Exception):
    walker.visitError(path, value)
    return

  # List
  if isinstance(value, list):
    # Not actually a tuple, but okay
    recurse = walker.enterList(value, path)
    if not recurse: return
    next_walker = walker if recurse is True else recurse

    with TempSetAdd(seen, id(value)):
      for i, x in enumerate(value):
        walk(x, next_walker, path=path + ['[%d]' % i], seen=seen)

      walker.leaveList(value, path)
    return

  # Scalar
  if not isinstance(value, framework.TupleLike):
    walker.visitScalar(path, value)
    return

  # Tuple
  recurse = walker.enterTuple(value, path)
  if not recurse: return
  next_walker = walker if recurse is True else recurse

  with TempSetAdd(seen, id(value)):
    keys = sorted(value.keys())
    for key in keys:
      key_path = path + [key]
      elm = get_or_error(value, key)
      walk(elm, next_walker, path=key_path, seen=seen)

    walker.leaveTuple(value, path)


class TempSetAdd(object):
  def __init__(self, set, value):
    self.set = set
    self.value = value

  def __enter__(self):
    self.set.add(self.value)
    return self

  def __exit__(self, value, type, tb):
    self.set.remove(self.value)


def _digest(value, digest):
  if isinstance(value, framework.TupleLike):
    digest.update('T')
    for k in value.keys():
      v = get_or_error(value, k)
      digest.update('K' + k)
      _digest(v, digest)
    digest.update('E')
  elif isinstance(value, list):
    digest.update('L')
    for x in value:
      _digest(x, digest)
    digest.update('E')
  else:
    # Otherwise add the string representation of value to the digest.
    digest.update('S' + str(value))


def fingerprint(value):
  """Return a hash value that uniquely identifies the GCL value."""
  h = hashlib.sha256()
  _digest(value, h)
  return h.digest().encode('hex')


class Color(object):
  yellow = '\033[93m'
  endc = '\033[0m'
  red = '\033[91m'
  green = '\033[92m'
  cyan = '\033[96m'

  @classmethod
  def noColorize(cls, text, color):
    return text

  @classmethod
  def doColorize(cls, text, color):
    if not color:
      return text
    return '%s%s%s' % (getattr(cls, color), text, cls.endc)

  if sys.stdout.isatty():
    colorize = doColorize
  else:
    colorize = noColorize


class Cell(object):
  def __init__(self, text='', color=''):
    self.text = ''
    self.len = 0
    if text:
      self.write(text, color)

  def write(self, text, color=''):
    self.text += Color.colorize(text, color)
    self.len += len(text)
    return self

  def copy(self):
    import copy
    return copy.copy(self)


class ConsoleTable(object):
  """Class to print a table of varying column sizes."""
  def __init__(self):
    # Cells are lists with a text and a width
    self.table = [[]]

  def add(self, cell):
    self.table[-1].append(cell)

  def addAll(self, cells):
    self.table[-1].extend(cells)

  def feedLine(self):
    self.table.append([])

  def currentRowCopy(self):
    return [c.copy() for c in self.table[-1]]

  def _findColumnSizes(self):
    sizes = []
    for row in self.table:
      while len(sizes) < len(row):
        sizes.append(0)
      for i, cell in enumerate(row[:-1]):
        sizes[i] = max(sizes[i], cell.len)
    return sizes

  def printOut(self, fobj):
    sizes = self._findColumnSizes()
    for row in self.table:
      for i, cell in enumerate(row):
        if i != 0:
          fobj.write(' ')
        fobj.write(cell.text)
        if i < len(row) - 1:
          fobj.write(' ' * (sizes[i] - cell.len))
      fobj.write('\n')


def find_relative(current_dir, rel_path):
  if rel_path.startswith('/'):
    return rel_path
  else:
    return path.normpath(path.join(current_dir, rel_path))


def no_filter(filename, x):
  return x


def compact_error(err):
  """Return the the last 2 error messages from an error stack.

  These error messages turns out to be the most descriptive.
  """
  def err2(e):
    if isinstance(e, exceptions.EvaluationError) and e.inner:
      message, i = err2(e.inner)
      if i == 1:
        return ', '.join([e.args[0], str(e.inner)]), i + 1
      else:
        return message, i + 1
    else:
      return str(e), 1
  return err2(err)[0]


def interpolate_json(filename, x):
  if isinstance(x, int) or isinstance(x, float):
    return x
  return InterpolatableJSON(x)


class InterpolatableJSON(framework.TupleLike):
  """JSON list or dict in which string values can be string-interpolated."""
  def __init__(self, obj, subs=None):
    self.obj = obj
    self.subs = subs or {}
    self.evalled = None
    self.tuples = [self]

  def _eval(self):
    if not self.evalled:
      self.evalled = self._translate(self.obj)

  def _translate(self, x):
    if isinstance(x, dict):
      return {self._translate(k): self._translate(v) for k, v in p6_iteritems(x)}
    if isinstance(x, list):
      return [self._translate(y) for y in x]
    if framework.is_str(x):
      return x.format(**self.subs)
    return x

  def __call__(self, other):
    if not hasattr(other, 'items'):
      raise RuntimeError('Can only combine JSON objects with tuples')

    return InterpolatableJSON(self.obj, dict(self.subs, **dict(other.items())))

  def __getitem__(self, key):
    self._eval()
    return self.evalled[key]

  def items(self):
    self._eval()
    return self.evalled.items()

  def iteritems(self):
    self._eval()
    return p6_iteritems(self.evalled)

  def __len__(self):
    return len(self.obj)

  def __iter__(self):
    self._eval()
    return iter(self.evalled)

  def __contains__(self, key):
    self._eval()
    return key in self.evalled

  def keys(self):
    self._eval()
    return self.evalled.keys()

  def __zero__(self):
    return self.obj.__zero__()

  def __nonzero__(self):
    return self.obj.__nonzero__()

  def __str__(self):
    self._eval()
    return str(self.evalled)

  def __repr__(self):
    self._eval()
    return repr(self.evalled)


class JSONLoader(object):
  """A loader that also is able to load JSON files and directories.

  Allows filtering of the loaded JSON through a modifier function, if
  necessary (for example, SubstitutableDict).
  """
  def __init__(self, fs, filter_fn=None):
    self.fs = fs
    self.cache = framework.Cache()
    self.filter_fn = filter_fn or no_filter

  def __call__(self, current_file, rel_path, env=None):
    nice_path, full_path = self.fs.resolve(current_file, rel_path)

    if path.splitext(nice_path)[1] == '.json':
      # Load as JSON
      do_load = lambda: self.filter_fn(nice_path, json.loads(self.fs.load(full_path)))
    else:
      # Load as GCL
      import gcl
      do_load = lambda: gcl.loads(self.fs.load(full_path), filename=nice_path, loader=self, env=env)
    return self.cache.get(full_path, do_load)

"""GCL utility functions.

These utility functions are intended for GCL CONSUMERS.
"""
from __future__ import absolute_import

import json
import hashlib
import logging
import sys
from os import path
import time

from . import framework
from . import exceptions


logger = logging.getLogger('gcl')


class LogTime(object):
  def __init__(self, name):
    self.name = name

  def __enter__(self):
    self.start = time.time()
    return self

  def __exit__(self, value, type, tb):
    logger.info('%s, time taken %.1fs', self.name, time.time() - self.start)


class RecursionException(RuntimeError):
  pass


class ExpressionWalker(object):
  """Defines the interface for walk()."""

  def enterTuple(self, tuple, path):
    """Called for every tuple.

    If this returns Falsey, the elements of the tuple will not be recursed over and leaveTuple()
    will not be called. It can also return True, or an object, in which case the walk will be
    resumed using the current or the indicated object, respectively.
    """
    return True

  def leaveTuple(self, tuple, path):
    pass

  def enterList(self, list, path):
    # Backwards compat
    return self.enterTuple(list, path)

  def leaveList(self, list, path):
    # Backwards compat
    return self.leaveTuple(list, path)

  def visitRecursion(self, key_path):
    self.visitError(key_path, RecursionException('recursion'))

  def visitError(self, key_path, ex):
    pass

  def visitScalar(self, key_path, value):
    pass


def get_or_error(tuple, key):
  try:
    return tuple[key]
  except exceptions.EvaluationError as e:
    return e


# Python 2/3 compatibility for iteritems
p6_iteritems = (lambda x: x.iteritems()) if hasattr({}, 'iteritems') else (lambda x: x.items())


def to_python(value, seen=None):
  """Reify values to their Python equivalents.

  Does recursion detection, failing when that happens.
  """
  seen = seen or set()
  if isinstance(value, framework.TupleLike):
    if value.ident in seen:
      raise RecursionException('to_python: infinite recursion while evaluating %r' % value)
    new_seen = seen.union([value.ident])
    return {k: to_python(value[k], seen=new_seen) for k in value.exportable_keys()}
  if isinstance(value, dict):
    return {k: to_python(value[k], seen=seen) for k in value.keys()}
  if isinstance(value, list):
    return [to_python(x, seen=seen) for x in value]
  return value


def walk(value, walker, path=None, seen=None):
  """Walks the _evaluated_ tree of the given GCL tuple.

  The appropriate methods of walker will be invoked for every element in the
  tree.
  """
  seen = seen or set()
  path = path or []

  # Recursion
  if id(value) in seen:
    walker.visitRecursion(path)
    return

  # Error
  if isinstance(value, Exception):
    walker.visitError(path, value)
    return

  # List
  if isinstance(value, list):
    # Not actually a tuple, but okay
    recurse = walker.enterList(value, path)
    if not recurse: return
    next_walker = walker if recurse is True else recurse

    with TempSetAdd(seen, id(value)):
      for i, x in enumerate(value):
        walk(x, next_walker, path=path + ['[%d]' % i], seen=seen)

      walker.leaveList(value, path)
    return

  # Scalar
  if not isinstance(value, framework.TupleLike):
    walker.visitScalar(path, value)
    return

  # Tuple
  recurse = walker.enterTuple(value, path)
  if not recurse: return
  next_walker = walker if recurse is True else recurse

  with TempSetAdd(seen, id(value)):
    keys = sorted(value.keys())
    for key in keys:
      key_path = path + [key]
      elm = get_or_error(value, key)
      walk(elm, next_walker, path=key_path, seen=seen)

    walker.leaveTuple(value, path)


class TempSetAdd(object):
  def __init__(self, set, value):
    self.set = set
    self.value = value

  def __enter__(self):
    self.set.add(self.value)
    return self

  def __exit__(self, value, type, tb):
    self.set.remove(self.value)


def _digest(value, digest):
  if isinstance(value, framework.TupleLike):
    digest.update('T')
    for k in value.keys():
      v = get_or_error(value, k)
      digest.update('K' + k)
      _digest(v, digest)
    digest.update('E')
  elif isinstance(value, list):
    digest.update('L')
    for x in value:
      _digest(x, digest)
    digest.update('E')
  else:
    # Otherwise add the string representation of value to the digest.
    digest.update('S' + str(value))


def fingerprint(value):
  """Return a hash value that uniquely identifies the GCL value."""
  h = hashlib.sha256()
  _digest(value, h)
  return h.digest().encode('hex')


class Color(object):
  yellow = '\033[93m'
  endc = '\033[0m'
  red = '\033[91m'
  green = '\033[92m'
  cyan = '\033[96m'

  @classmethod
  def noColorize(cls, text, color):
    return text

  @classmethod
  def doColorize(cls, text, color):
    if not color:
      return text
    return '%s%s%s' % (getattr(cls, color), text, cls.endc)

  if sys.stdout.isatty():
    colorize = doColorize
  else:
    colorize = noColorize


class Cell(object):
  def __init__(self, text='', color=''):
    self.text = ''
    self.len = 0
    if text:
      self.write(text, color)

  def write(self, text, color=''):
    self.text += Color.colorize(text, color)
    self.len += len(text)
    return self

  def copy(self):
    import copy
    return copy.copy(self)


class ConsoleTable(object):
  """Class to print a table of varying column sizes."""
  def __init__(self):
    # Cells are lists with a text and a width
    self.table = [[]]

  def add(self, cell):
    self.table[-1].append(cell)

  def addAll(self, cells):
    self.table[-1].extend(cells)

  def feedLine(self):
    self.table.append([])

  def currentRowCopy(self):
    return [c.copy() for c in self.table[-1]]

  def _findColumnSizes(self):
    sizes = []
    for row in self.table:
      while len(sizes) < len(row):
        sizes.append(0)
      for i, cell in enumerate(row[:-1]):
        sizes[i] = max(sizes[i], cell.len)
    return sizes

  def printOut(self, fobj):
    sizes = self._findColumnSizes()
    for row in self.table:
      for i, cell in enumerate(row):
        if i != 0:
          fobj.write(' ')
        fobj.write(cell.text)
        if i < len(row) - 1:
          fobj.write(' ' * (sizes[i] - cell.len))
      fobj.write('\n')


def find_relative(current_dir, rel_path):
  if rel_path.startswith('/'):
    return rel_path
  else:
    return path.normpath(path.join(current_dir, rel_path))


def no_filter(filename, x):
  return x


def compact_error(err):
  """Return the the last 2 error messages from an error stack.

  These error messages turns out to be the most descriptive.
  """
  def err2(e):
    if isinstance(e, exceptions.EvaluationError) and e.inner:
      message, i = err2(e.inner)
      if i == 1:
        return ', '.join([e.args[0], str(e.inner)]), i + 1
      else:
        return message, i + 1
    else:
      return str(e), 1
  return err2(err)[0]


def interpolate_json(filename, x):
  if isinstance(x, int) or isinstance(x, float):
    return x
  return InterpolatableJSON(x)


class InterpolatableJSON(framework.TupleLike):
  """JSON list or dict in which string values can be string-interpolated."""
  def __init__(self, obj, subs=None):
    self.obj = obj
    self.subs = subs or {}
    self.evalled = None
    self.tuples = [self]

  def _eval(self):
    if not self.evalled:
      self.evalled = self._translate(self.obj)

  def _translate(self, x):
    if isinstance(x, dict):
      return {self._translate(k): self._translate(v) for k, v in p6_iteritems(x)}
    if isinstance(x, list):
      return [self._translate(y) for y in x]
    if framework.is_str(x):
      return x.format(**self.subs)
    return x

  def __call__(self, other):
    if not hasattr(other, 'items'):
      raise RuntimeError('Can only combine JSON objects with tuples')

    return InterpolatableJSON(self.obj, dict(self.subs, **dict(other.items())))

  def __getitem__(self, key):
    self._eval()
    return self.evalled[key]

  def items(self):
    self._eval()
    return self.evalled.items()

  def iteritems(self):
    self._eval()
    return p6_iteritems(self.evalled)

  def __len__(self):
    return len(self.obj)

  def __iter__(self):
    self._eval()
    return iter(self.evalled)

  def __contains__(self, key):
    self._eval()
    return key in self.evalled

  def keys(self):
    self._eval()
    return self.evalled.keys()

  def __zero__(self):
    return self.obj.__zero__()

  def __nonzero__(self):
    return self.obj.__nonzero__()

  def __str__(self):
    self._eval()
    return str(self.evalled)

  def __repr__(self):
    self._eval()
    return repr(self.evalled)


class JSONLoader(object):
  """A loader that also is able to load JSON files and directories.

  Allows filtering of the loaded JSON through a modifier function, if
  necessary (for example, SubstitutableDict).
  """
  def __init__(self, fs, filter_fn=None):
    self.fs = fs
    self.cache = framework.Cache()
    self.filter_fn = filter_fn or no_filter

  def __call__(self, current_file, rel_path, env=None):
    nice_path, full_path = self.fs.resolve(current_file, rel_path)

    if path.splitext(nice_path)[1] == '.json':
      # Load as JSON
      do_load = lambda: self.filter_fn(nice_path, json.loads(self.fs.load(full_path)))
    else:
      # Load as GCL
      import gcl
      do_load = lambda: gcl.loads(self.fs.load(full_path), filename=nice_path, loader=self, env=env)
    return self.cache.get(full_path, do_load)
GCL utility functions.  These utility functions are intended for GCL CONSUMERS. Defines the interface for walk(). Called for every tuple.      If this returns Falsey, the elements of the tuple will not be recursed over and leaveTuple()     will not be called. It can also return True, or an object, in which case the walk will be     resumed using the current or the indicated object, respectively. # Backwards compat # Backwards compat # Python 2/3 compatibility for iteritems Reify values to their Python equivalents.    Does recursion detection, failing when that happens. Walks the _evaluated_ tree of the given GCL tuple.    The appropriate methods of walker will be invoked for every element in the   tree. # Recursion # Error # List # Not actually a tuple, but okay # Scalar # Tuple # Otherwise add the string representation of value to the digest. Return a hash value that uniquely identifies the GCL value. Class to print a table of varying column sizes. # Cells are lists with a text and a width Return the the last 2 error messages from an error stack.    These error messages turns out to be the most descriptive. JSON list or dict in which string values can be string-interpolated. A loader that also is able to load JSON files and directories.    Allows filtering of the loaded JSON through a modifier function, if   necessary (for example, SubstitutableDict). # Load as JSON # Load as GCL