data/python/FreeFOAM/compat.py

   1 #-------------------------------------------------------------------------------
   2 #               ______                _     ____          __  __
   3 #              |  ____|             _| |_  / __ \   /\   |  \/  |
   4 #              | |__ _ __ ___  ___ /     \| |  | | /  \  | \  / |
   5 #              |  __| '__/ _ \/ _ ( (| |) ) |  | |/ /\ \ | |\/| |
   6 #              | |  | | |  __/  __/\_   _/| |__| / ____ \| |  | |
   7 #              |_|  |_|  \___|\___|  |_|   \____/_/    \_\_|  |_|
   8 #
   9 #                   FreeFOAM: The Cross-Platform CFD Toolkit
  10 #
  11 # Copyright (C) 2008-2011 Michael Wild <themiwi@users.sf.net>
  12 #                         Gerber van der Graaf <gerber_graaf@users.sf.net>
  13 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007 Python Software
  14 #                         Foundation; All Rights Reserved
  15 #-------------------------------------------------------------------------------
  16 # License
  17 #   This file is part of FreeFOAM.
  18 #
  19 #   FreeFOAM is free software; you can redistribute it and/or modify it
  20 #   under the terms of the GNU General Public License as published by the
  21 #   Free Software Foundation; either version 2 of the License, or (at your
  22 #   option) any later version.
  23 #
  24 #   FreeFOAM is distributed in the hope that it will be useful, but WITHOUT
  25 #   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  26 #   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  27 #   for more details.
  28 #
  29 #   You should have received a copy of the GNU General Public License
  30 #   along with FreeFOAM; if not, write to the Free Software Foundation,
  31 #   Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  32 #
  33 #   Some of the below functions have been backported from Python. They are
  34 #   licensed under the Python Software Foundation License version 2. The full
  35 #   license text is available at http://docs.python.org/license.html. Notably,
  36 #   the functions _nt_relpath and _posix_relpath are adapted versions of
  37 #   ntpath.relpath and posixpath.relpath, respectively and are copyrighted to
  38 #   the Python Software Foundation. _check_call and _check_output were modified
  39 #   from subprocess.check_call and subprocess.check_output which are
  40 #   copyrighted to Peter Astrand <astrand@lysator.liu.se>.
  41 #
  42 # Description
  43 #   Compatibility functions that make Python 3.x code work with 2.x
  44 #   interpreters.
  45 #
  46 #-------------------------------------------------------------------------------
  47
  48 import sys as _sys
  49 import os.path as _op
  50 import os as _os
  51 import subprocess as _subprocess
  52
  53 def echo(*args, **kwargs):
  54    """print() replacement which does not depend on the Python version"""
  55    if 'sep' in kwargs:
  56       sep = kwargs['sep']
  57    else:
  58       sep = ' '
  59    if 'end' in kwargs:
  60       end = kwargs['end']
  61    else:
  62       end = '\n'
  63    if 'file' in kwargs:
  64       file = kwargs['file']
  65    else:
  66       file = _sys.stdout
  67    file.write(str(sep).join(map(str, args)))
  68    end = str(end)
  69    if len(end):
  70       file.write(end)
  71
  72 # check whether Python version is < 3.0
  73 if _sys.hexversion < 0x030000f0:
  74   # replace the standard functions
  75   import itertools
  76   filter = itertools.ifilter
  77   map = itertools.imap
  78   zip = itertools.izip
  79   repr = unicode
  80   range = xrange
  81 else:
  82   callable = None
  83   xrange = None
  84
  85 # check whether Python version is < 2.6
  86 if _sys.hexversion < 0x020600f0:
  87   def _posix_relpath(path, start=_os.curdir):
  88     """Return a relative version of a path, POSIX version"""
  89
  90     if not path:
  91         raise ValueError("no path specified")
  92
  93     start_list = _op.abspath(start).split(_op.sep)
  94     path_list = _op.abspath(path).split(_op.sep)
  95
  96     # Work out how much of the filepath is shared by start and path.
  97     i = len(_op.commonprefix([start_list, path_list]))
  98
  99     rel_list = [_op.pardir] * (len(start_list)-i) + path_list[i:]
 100     if not rel_list:
 101         return _os.curdir
 102     return _op.join(*rel_list)
 103
 104   def _nt_relpath(path, start=_os.curdir):
 105       """Return a relative version of a path, Windows version"""
 106
 107       if not path:
 108           raise ValueError("no path specified")
 109       start_list = _op.abspath(start).split(_op.sep)
 110       path_list = _op.abspath(path).split(_op.sep)
 111       if start_list[0].lower() != path_list[0].lower():
 112           unc_path, rest = _op.splitunc(path)
 113           unc_start, rest = _op.splitunc(start)
 114           if bool(unc_path) ^ bool(unc_start):
 115               raise ValueError("Cannot mix UNC and non-UNC paths (%s and %s)"
 116                                                                   % (path, start))
 117           else:
 118               raise ValueError("path is on drive %s, start on drive %s"
 119                                                   % (path_list[0], start_list[0]))
 120       # Work out how much of the filepath is shared by start and path.
 121       for i in range(min(len(start_list), len(path_list))):
 122           if start_list[i].lower() != path_list[i].lower():
 123               break
 124       else:
 125           i += 1
 126
 127       rel_list = [_op.pardir] * (len(start_list)-i) + path_list[i:]
 128       if not rel_list:
 129           return _os.curdir
 130       return _op.join(*rel_list)
 131
 132   # provide os.path.relpath
 133   if _os.name == 'posix':
 134     _op.relpath = _posix_relpath
 135   elif _os.name == 'nt':
 136     _op.relpath = _nt_relpath
 137   else:
 138     raise Exception('No implementation of os.path.relpath available')
 139
 140 # check whether Python version is < 2.5
 141 if _sys.hexversion < 0x020500f0:
 142    # there is no BaseException class
 143    BaseException = Exception
 144
 145    # there is no subprocess.check_call() function
 146    def _check_call(*popernargs, **kwargs):
 147       retcode = _subprocess.call(*popenargs, **kwargs)
 148       if retcode:
 149          cmd = kwargs.get("args")
 150          if cmd is None:
 151             cmd = popenargs[0]
 152          raise _subprocess.CalledProcessError(retcode, cmd)
 153       return 0
 154    _subprocess.check_call = _check_call
 155
 156    # there is no subprocess.check_output() function
 157    def _check_output(*popenargs, **kwargs):
 158       if 'stdout' in kwargs:
 159          raise ValueError('stdout argument not allowed, it will be overridden.')
 160       process = _subprocess.Popen(stdout=PIPE, *popenargs, **kwargs)
 161       output, unused_err = process.communicate()
 162       retcode = process.poll()
 163       if retcode:
 164          cmd = kwargs.get("args")
 165          if cmd is None:
 166             cmd = popenargs[0]
 167          raise _subprocess.CalledProcessError(retcode, cmd, output=output)
 168       return output
 169    _subprocess.check_output = _check_output
 170
 171 # ------------------------- vim: set sw=3 sts=3 et: --------------- end-of-file