Merge pull request #2721 from boegel/no_more_basestring

consistently use 'string_type' from easybuild.tools.py2vs3 rather than 'basestring'

Author: migueldiascosta

easybuild/framework/easyblock.py

@@ -87,6 +87,7 @@
 from easybuild.tools.modules import invalidate_module_caches_for, get_software_root, get_software_root_env_var_name
 from easybuild.tools.modules import get_software_version_env_var_name
 from easybuild.tools.package.utilities import package
+from easybuild.tools.py2vs3 import string_type
 from easybuild.tools.repository.repository import init_repository
 from easybuild.tools.toolchain import DUMMY_TOOLCHAIN_NAME
 from easybuild.tools.systemtools import det_parallelism, use_group
@@ -344,7 +345,7 @@ def fetch_sources(self, sources=None, checksums=None):
         for index, source in enumerate(sources):
             extract_cmd, download_filename, source_urls, git_config = None, None, None, None
 
-            if isinstance(source, basestring):
+            if isinstance(source, string_type):
                 filename = source
 
             elif isinstance(source, dict):
@@ -409,7 +410,7 @@ def fetch_patches(self, patch_specs=None, extension=False, checksums=None):
                 # no 'isinstance(..., int)', since that would make True/False also acceptable
                 if type(patch_spec[1]) == int:
                     level = patch_spec[1]
-                elif isinstance(patch_spec[1], basestring):
+                elif isinstance(patch_spec[1], string_type):
                     # non-patch files are assumed to be files to copy
                     if not patch_spec[0].endswith('.patch'):
                         copy_file = True
@@ -559,7 +560,7 @@ def fetch_extension_sources(self, skip_checksums=False):
                         else:
                             raise EasyBuildError("Source for extension %s not found.", ext)
 
-            elif isinstance(ext, basestring):
+            elif isinstance(ext, string_type):
                 exts_sources.append({'name': ext})
 
             else:
@@ -696,7 +697,7 @@ def obtain_file(self, filename, extension=False, urls=None, download_filename=No
 
                     url_filename = download_filename or filename
 
-                    if isinstance(url, basestring):
+                    if isinstance(url, string_type):
                         if url[-1] in ['=', '/']:
                             fullurl = "%s%s" % (url, url_filename)
                         else:
@@ -1117,7 +1118,7 @@ def make_module_extra(self, altroot=None, altversion=None):
             lines.append(self.module_generator.set_environment(key, value))
 
         for (key, value) in self.cfg['modextrapaths'].items():
-            if isinstance(value, basestring):
+            if isinstance(value, string_type):
                 value = [value]
             elif not isinstance(value, (tuple, list)):
                 raise EasyBuildError("modextrapaths dict value %s (type: %s) is not a list or tuple",
@@ -1247,7 +1248,7 @@ def make_module_req(self):
                 if self.dry_run:
                     self.dry_run_msg(" $%s: %s" % (key, ', '.join(requirements[key])))
                 reqs = requirements[key]
-                if isinstance(reqs, basestring):
+                if isinstance(reqs, string_type):
                     self.log.warning("Hoisting string value %s into a list before iterating over it", reqs)
                     reqs = [reqs]
 
@@ -1372,7 +1373,7 @@ def skip_extensions(self):
 
         if not exts_filter or len(exts_filter) == 0:
             raise EasyBuildError("Skipping of extensions, but no exts_filter set in easyconfig")
-        elif isinstance(exts_filter, basestring) or len(exts_filter) != 2:
+        elif isinstance(exts_filter, string_type) or len(exts_filter) != 2:
             raise EasyBuildError('exts_filter should be a list or tuple of ("command","input")')
         cmdtmpl = exts_filter[0]
         cmdinputtmpl = exts_filter[1]
@@ -1743,7 +1744,7 @@ def check_checksums(self):
         for ext in self.cfg['exts_list']:
             # just skip extensions for which only a name is specified
             # those are just there to check for things that are in the "standard library"
-            if not isinstance(ext, basestring):
+            if not isinstance(ext, string_type):
                 ext_name = ext[0]
                 # take into account that extension may be a 2-tuple with just name/version
                 ext_opts = ext[2] if len(ext) == 3 else {}
@@ -1928,7 +1929,7 @@ def extensions_step(self, fetch=False):
         if hasattr(exts_defaultclass, '__iter__'):
             self.log.nosupport("Module path for default class is explicitly defined", '2.0')
 
-        elif isinstance(exts_defaultclass, basestring):
+        elif isinstance(exts_defaultclass, string_type):
             # proper way: derive module path from specified class name
             default_class = exts_defaultclass
             default_class_modpath = get_module_path(default_class, generic=True)
@@ -2054,7 +2055,7 @@ def post_install_step(self):
             if not isinstance(self.cfg['postinstallcmds'], (list, tuple)):
                 raise EasyBuildError("Invalid value for 'postinstallcmds', should be list or tuple of strings.")
             for cmd in self.cfg['postinstallcmds']:
-                if not isinstance(cmd, basestring):
+                if not isinstance(cmd, string_type):
                     raise EasyBuildError("Invalid element in 'postinstallcmds', not a string: %s", cmd)
                 run_cmd(cmd, simple=True, log_ok=True, log_all=True)
 
@@ -2186,7 +2187,7 @@ def _sanity_check_step_common(self, custom_paths, custom_commands):
         for i, command in enumerate(commands):
             # set command to default. This allows for config files with
             # non-tuple commands
-            if isinstance(command, basestring):
+            if isinstance(command, string_type):
                 self.log.debug("Using %s as sanity check command" % command)
                 commands[i] = command
             else:
@@ -2287,7 +2288,7 @@ def xs2str(xs):
         for key, (typ, check_fn) in path_keys_and_check.items():
 
             for xs in paths[key]:
-                if isinstance(xs, basestring):
+                if isinstance(xs, string_type):
                     xs = (xs,)
                 elif not isinstance(xs, tuple):
                     raise EasyBuildError("Unsupported type %s encountered in '%s', not a string or tuple",

easybuild/framework/easyconfig/easyconfig.py

@@ -66,7 +66,7 @@
 from easybuild.tools.module_naming_scheme.utilities import avail_module_naming_schemes, det_full_ec_version
 from easybuild.tools.module_naming_scheme.utilities import det_hidden_modname, is_valid_module_name
 from easybuild.tools.modules import modules_tool
-from easybuild.tools.py2vs3 import OrderedDict
+from easybuild.tools.py2vs3 import OrderedDict, string_type
 from easybuild.tools.systemtools import check_os_dependency
 from easybuild.tools.toolchain import DUMMY_TOOLCHAIN_NAME, DUMMY_TOOLCHAIN_VERSION
 from easybuild.tools.toolchain.toolchain import TOOLCHAIN_CAPABILITIES, TOOLCHAIN_CAPABILITY_CUDA
@@ -462,7 +462,7 @@ def update(self, key, value, allow_duplicate=True):
         Update a string configuration value with a value (i.e. append to it).
         """
         prev_value = self[key]
-        if isinstance(prev_value, basestring):
+        if isinstance(prev_value, string_type):
             if allow_duplicate or value not in prev_value:
                 self[key] = '%s %s ' % (prev_value, value)
         elif isinstance(prev_value, list):
@@ -563,7 +563,7 @@ def check_deprecated(self, path):
 
         deprecated = self['deprecated']
         if deprecated:
-            if isinstance(deprecated, basestring):
+            if isinstance(deprecated, string_type):
                 depr_msgs.append("easyconfig file '%s' is marked as deprecated:\n%s\n" % (path, deprecated))
             else:
                 raise EasyBuildError("Wrong type for value of 'deprecated' easyconfig parameter: %s", type(deprecated))
@@ -631,7 +631,7 @@ def validate_os_deps(self):
         not_found = []
         for dep in self['osdependencies']:
             # make sure we have a tuple
-            if isinstance(dep, basestring):
+            if isinstance(dep, string_type):
                 dep = (dep,)
             elif not isinstance(dep, tuple):
                 raise EasyBuildError("Non-tuple value type for OS dependency specification: %s (type %s)",
@@ -1389,7 +1389,7 @@ def resolve_template(value, tmpl_dict):
         - value: some python object (supported are string, tuple/list, dict or some mix thereof)
         - tmpl_dict: template dictionary
     """
-    if isinstance(value, basestring):
+    if isinstance(value, string_type):
         # simple escaping, making all '%foo', '%%foo', '%%%foo' post-templates values available,
         #         but ignore a string like '%(name)s'
         # behaviour of strings like '%(name)s',

easybuild/framework/easyconfig/format/format.py

@@ -39,6 +39,7 @@
 from easybuild.tools.build_log import EasyBuildError
 from easybuild.tools.configobj import Section
 from easybuild.tools.utilities import get_subclasses
+from easybuild.tools.py2vs3 import string_type
 
 
 # format is mandatory major.minor
@@ -312,7 +313,7 @@ def parse_sections(self, toparse, current):
                     value_type = self.VERSION_OPERATOR_VALUE_TYPES[key]
                     # list of supported toolchains/versions
                     # first one is default
-                    if isinstance(value, basestring):
+                    if isinstance(value, string_type):
                         # so the split should be unnecessary
                         # (if it's not a list already, it's just one value)
                         # TODO this is annoying. check if we can force this in configobj

easybuild/framework/easyconfig/format/one.py

@@ -44,6 +44,7 @@
 from easybuild.framework.easyconfig.templates import to_template_str
 from easybuild.tools.build_log import EasyBuildError, print_msg
 from easybuild.tools.filetools import read_file, write_file
+from easybuild.tools.py2vs3 import string_type
 from easybuild.tools.utilities import INDENT_4SPACES, quote_py_str
 
 
@@ -180,7 +181,7 @@ def _reformat_line(self, param_name, param_val, outer=False, addlen=0):
 
         else:
             # dependencies are already dumped as strings, so they do not need to be quoted again
-            if isinstance(param_val, basestring) and param_name not in DEPENDENCY_PARAMETERS:
+            if isinstance(param_val, string_type) and param_name not in DEPENDENCY_PARAMETERS:
                 res = quote_py_str(param_val)
 
         return res
@@ -336,7 +337,7 @@ def extract_comments(self, rawtxt):
                     # determine parameter value where the item value on this line is a part of
                     for key, val in parsed_ec.items():
                         item_val = re.sub(r',$', r'', rawline.rsplit('#', 1)[0].strip())
-                        if not isinstance(val, basestring) and item_val in str(val):
+                        if not isinstance(val, string_type) and item_val in str(val):
                             comment_key, comment_val = key, item_val
                             break
 

easybuild/framework/easyconfig/format/version.py

@@ -35,6 +35,7 @@
 
 from easybuild.base import fancylogger
 from easybuild.tools.build_log import EasyBuildError
+from easybuild.tools.py2vs3 import string_type
 from easybuild.tools.toolchain.utilities import search_toolchain
 
 
@@ -139,10 +140,10 @@ def test(self, test_version):
         if not self:
             raise EasyBuildError('Not a valid %s. Not initialised yet?', self.__class__.__name__)
 
-        if isinstance(test_version, basestring):
+        if isinstance(test_version, string_type):
             test_version = self._convert(test_version)
         elif not isinstance(test_version, EasyVersion):
-            raise EasyBuildError("test: argument should be a basestring or EasyVersion (type %s)", type(test_version))
+            raise EasyBuildError("test: argument should be a string or EasyVersion (type %s)", type(test_version))
 
         res = self.operator(test_version, self.version)
         self.log.debug("result of testing expression '%s %s %s': %s",
@@ -614,15 +615,15 @@ def add(self, versop_new, data=None, update=None):
         After add, versop_new is in the OrderedVersionOperators. If the same versop_new was already in it,
         it will update the data (if not None) (and not raise an error)
 
-        :param versop_new: VersionOperator instance (or will be converted into one if type basestring)
+        :param versop_new: VersionOperator instance (or will be converted into one if type string)
         :param data: additional data for supplied version operator to be stored
         :param update: if versop_new already exist and has data set, try to update the existing data with the new data; 
                        instead of overriding the existing data with the new data (method used for updating is .update)    
         """
-        if isinstance(versop_new, basestring):
+        if isinstance(versop_new, string_type):
             versop_new = VersionOperator(versop_new)
         elif not isinstance(versop_new, VersionOperator):
-            raise EasyBuildError("add: argument must be a VersionOperator instance or basestring: %s; type %s",
+            raise EasyBuildError("add: argument must be a VersionOperator instance or string: %s; type %s",
                                  versop_new, type(versop_new))
 
         if versop_new in self.versops:

easybuild/framework/easyconfig/format/yeb.py

@@ -34,6 +34,7 @@
 from easybuild.base import fancylogger
 from easybuild.framework.easyconfig.format.format import EasyConfigFormat
 from easybuild.framework.easyconfig.format.pyheaderconfigobj import build_easyconfig_constants_dict
+from easybuild.tools.py2vs3 import string_type
 from easybuild.tools.utilities import INDENT_4SPACES, only_if_module_is_available, quote_str
 
 
@@ -147,7 +148,7 @@ def quote_yaml_special_chars(val):
     Single quotes inside the string are escaped by doubling them.
     (see: http://symfony.com/doc/current/components/yaml/yaml_format.html#strings)
     """
-    if isinstance(val, basestring):
+    if isinstance(val, string_type):
         if "'" in val or YAML_SPECIAL_CHARS.intersection(val):
             val = "'%s'" % val.replace("'", "''")
 

easybuild/framework/easyconfig/parser.py

@@ -39,6 +39,7 @@
 from easybuild.framework.easyconfig.types import PARAMETER_TYPES, check_type_of_param_value
 from easybuild.tools.build_log import EasyBuildError
 from easybuild.tools.filetools import read_file, write_file
+from easybuild.tools.py2vs3 import string_type
 
 
 # deprecated easyconfig parameters, and their replacements
@@ -160,8 +161,8 @@ def _read(self, filename=None):
         except IOError as err:
             raise EasyBuildError('Failed to obtain content with %s: %s', self.get_fn, err)
 
-        if not isinstance(self.rawcontent, basestring):
-            msg = 'rawcontent is not basestring: type %s, content %s' % (type(self.rawcontent), self.rawcontent)
+        if not isinstance(self.rawcontent, string_type):
+            msg = 'rawcontent is not a string: type %s, content %s' % (type(self.rawcontent), self.rawcontent)
             raise EasyBuildError("Unexpected result for raw content: %s", msg)
 
     def _det_format_version(self):

easybuild/framework/easyconfig/style.py

@@ -34,6 +34,7 @@
 from easybuild.base import fancylogger
 from easybuild.framework.easyconfig.easyconfig import EasyConfig
 from easybuild.tools.build_log import EasyBuildError, print_msg
+from easybuild.tools.py2vs3 import string_type
 from easybuild.tools.utilities import only_if_module_is_available
 
 try:
@@ -158,7 +159,7 @@ def cmdline_easyconfigs_style_check(ecs):
         # if an EasyConfig instance is provided, just grab the corresponding file path
         if isinstance(ec, EasyConfig):
             path = ec.path
-        elif isinstance(ec, basestring):
+        elif isinstance(ec, string_type):
             path = ec
         else:
             raise EasyBuildError("Value of unknown type encountered in cmdline_easyconfigs_style_check: %s (type: %s)",

easybuild/framework/easyconfig/templates.py

@@ -34,6 +34,7 @@
 
 from easybuild.base import fancylogger
 from easybuild.tools.build_log import EasyBuildError
+from easybuild.tools.py2vs3 import string_type
 from easybuild.tools.systemtools import get_shared_lib_ext
 
 
@@ -207,7 +208,7 @@ def template_constant_dict(config, ignore=None, skip_lower=True):
             else:
                 raise EasyBuildError("Unexpected type for dependency: %s", dep)
 
-            if isinstance(dep_name, basestring) and dep_name.lower() == name.lower():
+            if isinstance(dep_name, string_type) and dep_name.lower() == name.lower():
                 template_values['%sver' % pref] = dep_version
                 template_values['%sshortver' % pref] = '.'.join(dep_version.split('.')[:2])
                 break

easybuild/tools/config.py

@@ -47,6 +47,7 @@
 from easybuild.base import fancylogger
 from easybuild.base.frozendict import FrozenDictKnownKeys
 from easybuild.tools.build_log import EasyBuildError
+from easybuild.tools.py2vs3 import string_type
 
 
 _log = fancylogger.getLogger('config', fname=False)
@@ -395,7 +396,7 @@ def init(options, config_options_dict):
 
     # make sure source path is a list
     sourcepath = tmpdict['sourcepath']
-    if isinstance(sourcepath, basestring):
+    if isinstance(sourcepath, string_type):
         tmpdict['sourcepath'] = sourcepath.split(':')
         _log.debug("Converted source path ('%s') to a list of paths: %s" % (sourcepath, tmpdict['sourcepath']))
     elif not isinstance(sourcepath, (tuple, list)):