processing: process_files -> process_file

It can only process one file, so it is a more meaningful name

Author: László Vaskó

tests/test_cleanup.py

@@ -9,7 +9,7 @@
 import pytest
 
 from unblob.models import File, Handler, Regex, ValidChunk
-from unblob.processing import ExtractionConfig, process_files
+from unblob.processing import ExtractionConfig, process_file
 from unblob.testing import check_result
 
 _ZIP_CONTENT = b"good file"
@@ -54,7 +54,7 @@ def test_remove_extracted_chunks(input_dir: Path, output_dir: Path):
         entropy_depth=0,
     )
 
-    all_reports = process_files(config, input_dir)
+    all_reports = process_file(config, input_dir)
     assert list(output_dir.glob("**/*.zip")) == []
     check_result(all_reports)
 
@@ -66,7 +66,7 @@ def test_keep_all_problematic_chunks(input_dir: Path, output_dir: Path):
         entropy_depth=0,
     )
 
-    all_reports = process_files(config, input_dir)
+    all_reports = process_file(config, input_dir)
     # damaged zip file should not be removed
     assert all_reports.errors != [], "Unexpectedly no errors found!"
     assert list(output_dir.glob("**/*.zip"))
@@ -79,7 +79,7 @@ def test_keep_all_unknown_chunks(input_dir: Path, output_dir: Path):
         entropy_depth=0,
     )
 
-    all_reports = process_files(config, input_dir)
+    all_reports = process_file(config, input_dir)
     assert list(output_dir.glob("**/*.unknown"))
     check_result(all_reports)
 
@@ -100,6 +100,6 @@ def test_keep_chunks_with_null_extractor(input_dir: Path, output_dir: Path):
         entropy_depth=0,
         handlers=(_HandlerWithNullExtractor,),
     )
-    all_reports = process_files(config, input_dir)
+    all_reports = process_file(config, input_dir)
     assert list(output_dir.glob("**/*.null"))
     check_result(all_reports)

tests/test_cli.py

@@ -174,11 +174,11 @@ def test_archive_success(
         / "regular"
         / "__input__/"
     )
-    process_files_mock = mock.MagicMock()
+    process_file_mock = mock.MagicMock()
     logger_config_mock = mock.MagicMock()
     new_params = params + ["--extract-dir", str(tmp_path), str(in_path)]
     with mock.patch.object(
-        unblob.cli, "process_files", process_files_mock
+        unblob.cli, "process_file", process_file_mock
     ), mock.patch.object(unblob.cli, "configure_logger", logger_config_mock):
         result = runner.invoke(unblob.cli.cli, new_params)
     assert result.exit_code == 0
@@ -192,7 +192,7 @@ def test_archive_success(
         process_num=expected_process_num,
         handlers=BUILTIN_HANDLERS,
     )
-    process_files_mock.assert_called_once_with(config, in_path)
+    process_file_mock.assert_called_once_with(config, in_path)
     logger_config_mock.assert_called_once_with(expected_verbosity, tmp_path)
 
 
@@ -218,13 +218,13 @@ def test_keep_extracted_chunks(
     )
     params = args + ["--extract-dir", str(tmp_path), str(in_path)]
 
-    process_files_mock = mock.MagicMock()
-    with mock.patch.object(unblob.cli, "process_files", process_files_mock):
+    process_file_mock = mock.MagicMock()
+    with mock.patch.object(unblob.cli, "process_file", process_file_mock):
         result = runner.invoke(unblob.cli.cli, params)
 
     assert result.exit_code == 0
-    process_files_mock.assert_called_once()
+    process_file_mock.assert_called_once()
     assert (
-        process_files_mock.call_args.args[0].keep_extracted_chunks
+        process_file_mock.call_args.args[0].keep_extracted_chunks
         == keep_extracted_chunks
     ), fail_message

tests/test_handlers.py

@@ -15,7 +15,7 @@
 
 from unblob import handlers
 from unblob.models import Handler
-from unblob.processing import ExtractionConfig, process_files
+from unblob.processing import ExtractionConfig, process_file
 from unblob.testing import (
     check_output_is_the_same,
     check_result,
@@ -32,7 +32,7 @@
 def test_all_handlers(
     input_dir: Path, output_dir: Path, extraction_config: ExtractionConfig
 ):
-    all_reports = process_files(extraction_config, input_dir)
+    all_reports = process_file(extraction_config, input_dir)
 
     check_output_is_the_same(output_dir, extraction_config.extract_root)
     check_result(all_reports)

unblob/cli.py

@@ -19,7 +19,7 @@
     DEFAULT_PROCESS_NUM,
     DEFAULT_SKIP_MAGIC,
     ExtractionConfig,
-    process_files,
+    process_file,
 )
 
 logger = get_logger()
@@ -192,7 +192,7 @@ def cli(
     )
 
     logger.info("Start processing file", file=file)
-    all_reports = process_files(config, file)
+    all_reports = process_file(config, file)
     return all_reports
 
 

unblob/processing.py

@@ -67,7 +67,7 @@ class ExtractionConfig:
 
 
 @terminate_gracefully
-def process_files(config: ExtractionConfig, path: Path) -> ProcessResult:
+def process_file(config: ExtractionConfig, path: Path) -> ProcessResult:
     task = Task(
         path=path,
         depth=0,

unblob/testing.py

@@ -46,7 +46,7 @@ def extraction_config(tmp_path: Path):
         keep_extracted_chunks=True,
     )
 
-    # Warmup lru_cache before ``process_files`` forks, so child
+    # Warmup lru_cache before ``process_file`` forks, so child
     # processes can reuse the prebuilt databases without overhead
     build_hyperscan_database(config.handlers)