Source code for gunittest.utils

GRASS Python testing framework utilities (general and test-specific)

Copyright (C) 2014 by the GRASS Development Team
This program is free software under the GNU General Public
License (>=v2). Read the file COPYING that comes with GRASS GIS
for details.

:authors: Vaclav Petras

import os
import sys
import shutil
import errno

[docs]def ensure_dir(directory): """Create all directories in the given path if needed.""" if not os.path.exists(directory): os.makedirs(directory)
[docs]def silent_rmtree(filename): """Remove the file but do nothing if file does not exist.""" try: shutil.rmtree(filename) except OSError as e: # errno.ENOENT is "No such file or directory" # re-raise if a different error occurred if e.errno != errno.ENOENT: raise
[docs]def do_doctest_gettext_workaround(): """Setups environment for doing a doctest with gettext usage. When using gettext with dynamically defined underscore function (``_("For translation")``), doctest does not work properly. One option is to use `import as` instead of dynamically defined underscore function but this would require change all modules which are used by tested module. This should be considered for the future. The second option is to define dummy underscore function and one other function which creates the right environment to satisfy all. This is done by this function. """ def new_displayhook(string): """A replacement for default `sys.displayhook`""" if string is not None: sys.stdout.write("%r\n" % (string,)) def new_translator(string): """A fake gettext underscore function.""" return string sys.displayhook = new_displayhook try: import __builtin__ except ImportError: import builtins as __builtin__ __builtin__._ = new_translator
_MAX_LENGTH = 80 # taken from unittest.util (Python 2.7) since it is not part of API # but we need it for the same reason as it is used un unittest's TestCase
[docs]def safe_repr(obj, short=False): try: result = repr(obj) except Exception: result = object.__repr__(obj) if not short or len(result) < _MAX_LENGTH: return result return result[:_MAX_LENGTH] + " [truncated]..."