Merge f3c6710 into ac9bee7

ah_bootstrap.py

@@ -94,6 +94,16 @@
 from setuptools.package_index import PackageIndex
 from setuptools.sandbox import run_setup
 
+# Note: The following import is required as a workaround to
+# https://github.com/astropy/astropy-helpers/issues/89; if we don't import this
+# module now, it will get cleaned up after `run_setup` is called, but that will
+# later cause the TemporaryDirectory class defined in it to stop working when
+# used later on by setuptools
+try:
+    import setuptools.py31compat
+except ImportError:
+    pass
+
 # TODO: Maybe enable checking for a specific version of astropy_helpers?
 DIST_NAME = 'astropy-helpers'
 PACKAGE_NAME = 'astropy_helpers'
@@ -162,7 +172,10 @@ def use_astropy_helpers(path=None, download_if_needed=None, index_url=None,
     if '--offline' in sys.argv:
         download_if_needed = False
         auto_upgrade = False
+        offline = True
         sys.argv.remove('--offline')
+    else:
+        offline = False
 
     if '--no-git' in sys.argv:
         use_git = False
@@ -177,6 +190,12 @@ def use_astropy_helpers(path=None, download_if_needed=None, index_url=None,
     if index_url is None:
         index_url = INDEX_URL
 
+    # If this is a release then the .git directory will not exist so we
+    # should not use git.
+    git_dir_exists = os.path.exists(os.path.join(os.path.dirname(__file__), '.git'))
+    if use_git is None and not git_dir_exists:
+        use_git = False
+
     if use_git is None:
         use_git = USE_GIT
 
@@ -199,7 +218,8 @@ def use_astropy_helpers(path=None, download_if_needed=None, index_url=None,
     elif not os.path.exists(path) or os.path.isdir(path):
         # Even if the given path does not exist on the filesystem, if it *is* a
         # submodule, `git submodule init` will create it
-        is_submodule = _check_submodule(path, use_git=use_git)
+        is_submodule = _check_submodule(path, use_git=use_git,
+                                        offline=offline)
 
         if is_submodule or os.path.isdir(path):
             log.info(
@@ -380,7 +400,7 @@ def _directory_import(path):
     return dist
 
 
-def _check_submodule(path, use_git=True):
+def _check_submodule(path, use_git=True, offline=False):
     """
     Check if the given path is a git submodule.
 
@@ -389,12 +409,12 @@ def _check_submodule(path, use_git=True):
     """
 
     if use_git:
-        return _check_submodule_using_git(path)
+        return _check_submodule_using_git(path, offline)
     else:
         return _check_submodule_no_git(path)
 
 
-def _check_submodule_using_git(path):
+def _check_submodule_using_git(path, offline):
     """
     Check if the given path is a git submodule.  If so, attempt to initialize
     and/or update the submodule if needed.
@@ -429,32 +449,50 @@ def _check_submodule_using_git(path):
                 '`git submodule status` command:\n{0}'.format(str(e)))
 
 
-    stdio_encoding = locale.getdefaultlocale()[1]
+    # Can fail of the default locale is not configured properly.  See
+    # https://github.com/astropy/astropy/issues/2749.  For the purposes under
+    # consideration 'latin1' is an acceptable fallback.
+    try:
+        stdio_encoding = locale.getdefaultlocale()[1] or 'latin1'
+    except ValueError:
+        # Due to an OSX oddity locale.getdefaultlocale() can also crash
+        # depending on the user's locale/language settings.  See:
+        # http://bugs.python.org/issue18378
+        stdio_encoding = 'latin1'
 
     if p.returncode != 0 or stderr:
-        stderr = stderr.decode(stdio_encoding)
         # Unfortunately the return code alone cannot be relied on, as
         # earlier versions of git returned 0 even if the requested submodule
         # does not exist
-        log.debug('git submodule command failed '
-                  'unexpectedly:\n{0}'.format(stderr))
-        return False
-    else:
-        stdout = stdout.decode(stdio_encoding)
-        # The stdout should only contain one line--the status of the
-        # requested submodule
-        m = _git_submodule_status_re.match(stdout)
-        if m:
-            # Yes, the path *is* a git submodule
-            _update_submodule(m.group('submodule'), m.group('status'))
-            return True
-        else:
-            log.warn(
-                'Unexpected output from `git submodule status`:\n{0}\n'
-                'Will attempt import from {1!r} regardless.'.format(
-                    stdout, path))
+        stderr = stderr.decode(stdio_encoding)
+
+        # This is a warning that occurs in perl (from running git submodule)
+        # which only occurs with a malformatted locale setting which can
+        # happen sometimes on OSX.  See again
+        # https://github.com/astropy/astropy/issues/2749
+        perl_warning = ('perl: warning: Falling back to the standard locale '
+                        '("C").')
+        if not stderr.strip().endswith(perl_warning):
+            # Some other uknown error condition occurred
+            log.warn('git submodule command failed '
+                     'unexpectedly:\n{0}'.format(stderr))
             return False
 
+    stdout = stdout.decode(stdio_encoding)
+    # The stdout should only contain one line--the status of the
+    # requested submodule
+    m = _git_submodule_status_re.match(stdout)
+    if m:
+        # Yes, the path *is* a git submodule
+        _update_submodule(m.group('submodule'), m.group('status'), offline)
+        return True
+    else:
+        log.warn(
+            'Unexpected output from `git submodule status`:\n{0}\n'
+            'Will attempt import from {1!r} regardless.'.format(
+                stdout, path))
+        return False
+
 
 def _check_submodule_no_git(path):
     """
@@ -498,9 +536,9 @@ def _check_submodule_no_git(path):
     try:
         cfg.readfp(gitmodules_fileobj)
     except Exception as exc:
-        log.warning('Malformatted .gitmodules file: {0}\n'
-                    '{1} cannot be assumed to be a git submodule.'.format(
-                        exc, path))
+        log.warn('Malformatted .gitmodules file: {0}\n'
+                 '{1} cannot be assumed to be a git submodule.'.format(
+                     exc, path))
         return False
 
     for section in cfg.sections():
@@ -515,16 +553,23 @@ def _check_submodule_no_git(path):
     return False
 
 
-def _update_submodule(submodule, status):
+def _update_submodule(submodule, status, offline):
     if status == ' ':
         # The submodule is up to date; no action necessary
         return
     elif status == '-':
+        if offline:
+            raise _AHBootstrapSystemExit(
+                "Cannot initialize the {0} submodule in --offline mode; this "
+                "requires being able to clone the submodule from an online "
+                "repository.".format(submodule))
         cmd = ['update', '--init']
-        log.warn('Initializing submodule {0!r}'.format(submodule))
+        action = 'Initializing'
     elif status == '+':
         cmd = ['update']
-        log.warn('Updating submodule {0!r}'.format(submodule))
+        action = 'Updating'
+        if offline:
+            cmd.append('--no-fetch')
     elif status == 'U':
         raise _AHBoostrapSystemExit(
             'Error: Submodule {0} contains unresolved merge conflicts.  '
@@ -540,9 +585,12 @@ def _update_submodule(submodule, status):
 
     err_msg = None
 
+    cmd = ['git', 'submodule'] + cmd + ['--', submodule]
+    log.warn('{0} {1} submodule with: `{2}`'.format(
+        action, submodule, ' '.join(cmd)))
+
     try:
-        p = sp.Popen(['git', 'submodule'] + cmd + ['--', submodule],
-                     stdout=sp.PIPE, stderr=sp.PIPE)
+        p = sp.Popen(cmd, stdout=sp.PIPE, stderr=sp.PIPE)
         stdout, stderr = p.communicate()
     except OSError as e:
         err_msg = str(e)