[scan-build-py] use python tempfile for tempdir

[rizsotto.mailinglist]

Summary

It's a chunk from D26390

tempdir method is used to be a default value for parent directory of the output directory. The implementation was following the Perl scan-build implementation. It tries to come up with a meaningful (most probably writable) place on the filesystem. The very same functionality is implemented in python tempfile module. It's tested better, it works on multiple platform and requires no additional code to use it.

[dcoughlin]

This this looks much cleaner to me!

I suppose this will break anyone who was setting TMPDIR, etc. to direct output. But if they were, they have a command-line flag they could use instead of an environment variable.

[rizsotto.mailinglist]

Thanks for the review Devin!

I suppose this will break anyone who was setting TMPDIR, etc. to direct output. But if they were, they have a command-line flag they could use instead of an environment variable.

Actually, TMPDIR,TEMP and TMP environment still kicks in as primary location if command line argument does not present. Would not make breaking change like that.

tools/scan-build-py/libscanbuild/__init__.py

def predicate(entry):
             return False
         return True
 
     predicate.unique = method
     predicate.state = set()
     return predicate
 
 
-def tempdir():
-    """ Return the default temorary directory. """
-
-    return os.getenv('TMPDIR', os.getenv('TEMP', os.getenv('TMP', '/tmp')))
-
-
 def run_build(command, *args, **kwargs):
     """ Run and report build command execution
 
     :param command: array of tokens
     :return: exit code of the process
     """
     environment = kwargs.get('env', os.environ)
     logging.debug('run build %s, in environment: %s', command, environment)

tools/scan-build-py/libscanbuild/arguments.py

 It also implements basic validation methods, related to the command.
 Validations are mostly calling specific help methods, or mangling values.
 """
 
 import os
 import sys
 import argparse
 import logging
-from libscanbuild import reconfigure_logging, tempdir
+import tempfile
+from libscanbuild import reconfigure_logging
 from libscanbuild.clang import get_checkers
 
 __all__ = ['parse_args_for_intercept_build', 'parse_args_for_analyze_build',
            'parse_args_for_scan_build']
 
 
 def parse_args_for_intercept_build():
     """ Parse and validate command-line arguments for intercept-build. """
parser.add_argument(
         directory. (You can specify this option multiple times.)
         Could be useful when project contains 3rd party libraries.""")
 
     output = parser.add_argument_group('output control options')
     output.add_argument(
         '--output',
         '-o',
         metavar='<path>',
-        default=tempdir(),
+        default=tempfile.gettempdir(),
         help="""Specifies the output directory for analyzer reports.
         Subdirectory will be created if default directory is targeted.""")
     output.add_argument(
         '--keep-empty',
         action='store_true',
         help="""Don't remove the build results directory even if no issues
         were reported.""")
     output.add_argument(

tools/scan-build-py/libscanbuild/intercept.py

 import re
 import itertools
 import json
 import glob
 import logging
 from libear import build_libear, TemporaryDirectory
 from libscanbuild import command_entry_point, compiler_wrapper, \
     wrapper_environment, run_command, run_build
-from libscanbuild import duplicate_check, tempdir
+from libscanbuild import duplicate_check
 from libscanbuild.compilation import split_command
 from libscanbuild.arguments import parse_args_for_intercept_build
 from libscanbuild.shell import encode, decode
 
 __all__ = ['capture', 'intercept_build', 'intercept_compiler_wrapper']
 
 GS = chr(0x1d)
 RS = chr(0x1e)
def post_processing(commands):
         else:
             previous = iter([])
         # filter out duplicate entries from both
         duplicate = duplicate_check(entry_hash)
         return (entry
                 for entry in itertools.chain(previous, current)
                 if os.path.exists(entry['file']) and not duplicate(entry))
 
-    with TemporaryDirectory(prefix='intercept-', dir=tempdir()) as tmp_dir:
+    with TemporaryDirectory(prefix='intercept-') as tmp_dir:
         # run the build command
         environment = setup_environment(args, tmp_dir)
         exit_code = run_build(args.build, env=environment)
         # read the intercepted exec calls
         exec_traces = itertools.chain.from_iterable(
             parse_exec_trace(os.path.join(tmp_dir, filename))
             for filename in sorted(glob.iglob(os.path.join(tmp_dir, '*.cmd'))))
         # do post processing