reduced usage of os.chdir() in Python scripts [skip ci]

Author: firewave

htmlreport/cppcheck-htmlreport

@@ -422,9 +422,8 @@ def git_blame(errors, path, file, blame_options):
     full_path = os.path.join(path, file)
     path, filename = os.path.split(full_path)
 
-    cwd = os.getcwd()
-    if path:
-        os.chdir(path)
+    if not path:
+        path = None  # make sure this is None
 
     cmd_args = ['git', 'blame', '-L %d,%d' % (first_line, last_line)]
     if '-w' in blame_options:
@@ -434,12 +433,10 @@ def git_blame(errors, path, file, blame_options):
     cmd_args = cmd_args + ['--porcelain', '--incremental', '--', filename]
 
     try:
-        result = subprocess.check_output(cmd_args)
+        result = subprocess.check_output(cmd_args, cwd=path)
         result = result.decode(locale.getpreferredencoding())
     except:
         return []
-    finally:
-        os.chdir(cwd)
 
     if result.startswith('fatal'):
         return []
@@ -659,7 +656,6 @@ def main() -> None:
         parser.error('No report directory set.')
 
     # Get the directory where source code files are located.
-    cwd = os.getcwd()
     source_dir = os.getcwd()
     if options.source_dir:
         source_dir = options.source_dir
@@ -918,7 +914,6 @@ def main() -> None:
         sys.stderr.write("\nConsider changing source-encoding (for example: \"htmlreport ... --source-encoding=\"iso8859-1\"\"\n")
 
     print('Creating style.css file')
-    os.chdir(cwd)       # going back to the cwd to find style.css
     with io.open(os.path.join(options.report_dir, 'style.css'), 'w') as css_file:
         css_file.write(STYLE_FILE)
 

test/cli/helloworld_test.py

@@ -9,13 +9,6 @@
 
 from testutils import create_gui_project_file, cppcheck
 
-# Run Cppcheck from project path
-def cppcheck_local(args):
-    cwd = os.getcwd()
-    os.chdir('helloworld')
-    ret, stdout, stderr = cppcheck(args)
-    os.chdir(cwd)
-    return ret, stdout, stderr
 
 def getRelativeProjectPath():
     return 'helloworld'
@@ -46,7 +39,7 @@ def test_relative_path():
 
 
 def test_local_path():
-    ret, stdout, stderr = cppcheck_local(['--template=cppcheck1', '.'])
+    ret, stdout, stderr = cppcheck(['--template=cppcheck1', '.'], cwd='helloworld')
     assert ret == 0, stdout
     assert stderr == '[main.c:5]: (error) Division by zero.\n'
 
@@ -58,13 +51,13 @@ def test_absolute_path():
     assert stderr == '[%s:5]: (error) Division by zero.\n' % filename
 
 def test_addon_local_path():
-    ret, stdout, stderr = cppcheck_local(['--addon=misra', '--enable=style', '--template=cppcheck1', '.'])
+    ret, stdout, stderr = cppcheck(['--addon=misra', '--enable=style', '--template=cppcheck1', '.'], cwd='helloworld')
     assert ret == 0, stdout
     assert stderr == ('[main.c:5]: (error) Division by zero.\n'
                       '[main.c:1]: (style) misra violation (use --rule-texts=<file> to get proper output)\n')
 
 def test_addon_local_path_not_enable():
-    ret, stdout, stderr = cppcheck_local(['--addon=misra', '--template=cppcheck1', '.'])
+    ret, stdout, stderr = cppcheck(['--addon=misra', '--template=cppcheck1', '.'], cwd='helloworld')
     assert ret == 0, stdout
     assert stderr == '[main.c:5]: (error) Division by zero.\n'
 
@@ -109,7 +102,7 @@ def test_basepath_absolute_path():
     assert stderr == '[main.c:5]: (error) Division by zero.\n'
 
 def test_vs_project_local_path():
-    ret, stdout, stderr = cppcheck_local(['--template=cppcheck1', '--project=helloworld.vcxproj'])
+    ret, stdout, stderr = cppcheck(['--template=cppcheck1', '--project=helloworld.vcxproj'], cwd='helloworld')
     assert ret == 0, stdout
     assert getVsConfigs(stdout, 'main.c') == 'Debug|Win32 Debug|x64 Release|Win32 Release|x64'
     assert stderr == '[main.c:5]: (error) Division by zero.\n'
@@ -131,7 +124,7 @@ def test_vs_project_absolute_path():
     assert stderr == '[%s:5]: (error) Division by zero.\n' % filename
 
 def test_cppcheck_project_local_path():
-    ret, stdout, stderr = cppcheck_local(['--template=cppcheck1', '--platform=win64', '--project=helloworld.cppcheck'])
+    ret, stdout, stderr = cppcheck(['--template=cppcheck1', '--platform=win64', '--project=helloworld.cppcheck'], cwd='helloworld')
     assert ret == 0, stdout
     assert getVsConfigs(stdout, 'main.c') == 'Debug|x64'
     assert stderr == '[main.c:5]: (error) Division by zero.\n'

test/cli/proj2_test.py

@@ -23,13 +23,6 @@ def create_compile_commands():
     with open('proj2/' + COMPILE_COMMANDS_JSON, 'wt') as f:
         f.write(json.dumps(j))
 
-# Run Cppcheck from project path
-def cppcheck_local(args):
-    cwd = os.getcwd()
-    os.chdir('proj2')
-    ret, stdout, stderr = cppcheck(args)
-    os.chdir(cwd)
-    return ret, stdout, stderr
 
 def test_file_filter():
     ret, stdout, stderr = cppcheck(['proj2/','--file-filter=proj2/a/*'])
@@ -43,7 +36,7 @@ def test_file_filter():
 
 def test_local_path():
     create_compile_commands()
-    ret, stdout, stderr = cppcheck_local(['--project=compile_commands.json'])
+    ret, stdout, stderr = cppcheck(['--project=compile_commands.json'], cwd='proj2')
     file1 = os.path.join('a', 'a.c')
     file2 = os.path.join('b', 'b.c')
     assert ret == 0, stdout
@@ -52,13 +45,13 @@ def test_local_path():
 
 def test_local_path_force():
     create_compile_commands()
-    ret, stdout, stderr = cppcheck_local(['--project=compile_commands.json', '--force'])
+    ret, stdout, stderr = cppcheck(['--project=compile_commands.json', '--force'], cwd='proj2')
     assert ret == 0, stdout
     assert stdout.find('AAA') >= 0
 
 def test_local_path_maxconfigs():
     create_compile_commands()
-    ret, stdout, stderr = cppcheck_local(['--project=compile_commands.json', '--max-configs=2'])
+    ret, stdout, stderr = cppcheck(['--project=compile_commands.json', '--max-configs=2'], cwd='proj2')
     assert ret == 0, stdout
     assert stdout.find('AAA') >= 0
 

tools/test-my-pr.py

@@ -52,7 +52,7 @@ def format_float(a, b=1):
     main_dir = os.path.join(work_path, 'tree-main')
 
     lib.set_jobs('-j' + str(args.j))
-    result_file = os.path.join(work_path, args.o)
+    result_file = os.path.abspath(os.path.join(work_path, args.o))
     (f, ext) = os.path.splitext(result_file)
     timing_file = f + '_timing' + ext
     your_repo_dir = os.path.dirname(os.path.dirname(os.path.abspath(sys.argv[0])))
@@ -77,8 +77,7 @@ def format_float(a, b=1):
         sys.exit(1)
 
     try:
-        os.chdir(your_repo_dir)
-        commit_id = (subprocess.check_output(['git', 'merge-base', 'origin/main', 'HEAD'])).strip().decode('ascii')
+        commit_id = (subprocess.check_output(['git', 'merge-base', 'origin/main', 'HEAD'], cwd=your_repo_dir)).strip().decode('ascii')
         with open(result_file, 'a') as myfile:
             myfile.write('Common ancestor: ' + commit_id + '\n\n')
         package_width = '140'
@@ -87,7 +86,6 @@ def format_float(a, b=1):
             myfile.write('{:{package_width}} {:{timing_width}} {:{timing_width}} {:{timing_width}}\n'.format(
                 'Package', 'main', 'your', 'Factor', package_width=package_width, timing_width=timing_width))
 
-        os.chdir(main_dir)
         subprocess.check_call(['git', 'fetch', '--depth=1', 'origin', commit_id])
         subprocess.check_call(['git', 'checkout', '-f', commit_id])
     except BaseException as e: