Merge pull request #41 from DakaraProject/refactor/37_as_file

Use `as_file` to get resources

Author: Neraste

tests/integration/test_feeder_songs.py

@@ -1,4 +1,4 @@
-from importlib.resources import path
+from importlib.resources import as_file, files
 from shutil import copy
 from tempfile import TemporaryDirectory
 from unittest import TestCase, skipUnless
@@ -21,10 +21,10 @@ def test_feed(self, mocked_http_client_dakara_class):
         # create the object
         with TemporaryDirectory() as temp:
             # copy required files
-            with path("tests.resources.media", "dummy.ass") as file:
+            with as_file(files("tests.resources.media").joinpath("dummy.ass")) as file:
                 copy(file, temp)
 
-            with path("tests.resources.media", "dummy.mkv") as file:
+            with as_file(files("tests.resources.media").joinpath("dummy.mkv")) as file:
                 copy(file, temp)
 
             config = {"server": {}, "kara_folder": str(temp)}

tests/integration/test_feeder_works.py

@@ -1,4 +1,4 @@
-from importlib.resources import path
+from importlib.resources import as_file, files
 from unittest import TestCase
 from unittest.mock import call, patch
 
@@ -31,8 +31,10 @@ def test_correct_work_file(self, mocked_http_client_dakara_class):
         ]
 
         # create the object
-        with path(
-            "tests.integration.resources.works", "correct_work_file.json"
+        with as_file(
+            files("tests.integration.resources.works").joinpath(
+                "correct_work_file.json"
+            )
         ) as filepath:
             feeder = WorksFeeder(self.config, filepath, progress=False)
 

tests/integration/test_metadata.py

@@ -1,5 +1,5 @@
 from datetime import timedelta
-from importlib.resources import path
+from importlib.resources import as_file, files
 from pathlib import Path
 from tempfile import TemporaryDirectory
 from unittest import TestCase, skipUnless
@@ -26,7 +26,7 @@ def test_parse_not_found_error(self):
 
     def test_get_duration(self):
         """Test to get duration."""
-        with path("tests.resources.media", "dummy.mkv") as file:
+        with as_file(files("tests.resources.media").joinpath("dummy.mkv")) as file:
             parser = MediainfoMetadataParser.parse(file)
 
         self.assertEqual(
@@ -35,14 +35,14 @@ def test_get_duration(self):
 
     def test_get_number_audio_tracks(self):
         """Test to get number of audio tracks."""
-        with path("tests.resources.media", "dummy.mkv") as file:
+        with as_file(files("tests.resources.media").joinpath("dummy.mkv")) as file:
             parser = MediainfoMetadataParser.parse(file)
 
         self.assertEqual(parser.get_audio_tracks_count(), 2)
 
     def test_get_number_subtitle_tracks(self):
         """Test to get number of subtitle tracks."""
-        with path("tests.resources.media", "dummy.mkv") as file:
+        with as_file(files("tests.resources.media").joinpath("dummy.mkv")) as file:
             parser = MediainfoMetadataParser.parse(file)
 
         self.assertEqual(parser.get_subtitle_tracks_count(), 1)
@@ -74,7 +74,7 @@ def test_parse_invalid_error(self):
 
     def test_get_duration(self):
         """Test to get duration."""
-        with path("tests.resources.media", "dummy.mkv") as file:
+        with as_file(files("tests.resources.media").joinpath("dummy.mkv")) as file:
             parser = FFProbeMetadataParser.parse(file)
 
         self.assertEqual(
@@ -83,14 +83,14 @@ def test_get_duration(self):
 
     def test_get_number_audio_tracks(self):
         """Test to get number of audio tracks."""
-        with path("tests.resources.media", "dummy.mkv") as file:
+        with as_file(files("tests.resources.media").joinpath("dummy.mkv")) as file:
             parser = FFProbeMetadataParser.parse(file)
 
         self.assertEqual(parser.get_audio_tracks_count(), 2)
 
     def test_get_number_subtitle_tracks(self):
         """Test to get number of subtitle tracks."""
-        with path("tests.resources.media", "dummy.mkv") as file:
+        with as_file(files("tests.resources.media").joinpath("dummy.mkv")) as file:
             parser = FFProbeMetadataParser.parse(file)
 
         self.assertEqual(parser.get_subtitle_tracks_count(), 1)

tests/integration/test_subtitle_extraction.py

@@ -1,4 +1,4 @@
-from importlib.resources import path
+from importlib.resources import as_file, files
 from pathlib import Path
 from unittest import TestCase, skipUnless
 
@@ -11,11 +11,11 @@ class FFmpegSubtitleExtractorTestCase(TestCase):
 
     def test_extract(self):
         """Test to extract subtitle from file."""
-        with path("tests.resources.media", "dummy.mkv") as file:
+        with as_file(files("tests.resources.media").joinpath("dummy.mkv")) as file:
             extractor = FFmpegSubtitleExtractor.extract(file)
             subtitle = extractor.get_subtitle()
 
-        with path("tests.resources.subtitles", "dummy.ass") as file:
+        with as_file(files("tests.resources.subtitles").joinpath("dummy.ass")) as file:
             subtitle_expected = file.read_text()
 
         self.assertEqual(subtitle, subtitle_expected)

tests/unit/test_customization.py

@@ -1,5 +1,5 @@
 import inspect
-from importlib import resources
+from importlib.resources import as_file, files
 from pathlib import Path
 from re import escape
 from types import ModuleType
@@ -254,7 +254,7 @@ def test_alteration(self, mocked_sys):
 class ImportFromFileTestCase(TestCase):
     def test_import_file(self):
         """Test to import a file."""
-        with resources.path("tests.resources", "my_module.py") as file:
+        with as_file(files("tests.resources").joinpath("my_module.py")) as file:
             module = customization.import_from_file(Path(file))
 
         self.assertTrue(inspect.ismodule(module))

tests/unit/test_directory.py

@@ -1,4 +1,4 @@
-from importlib.resources import path
+from importlib.resources import as_file, files
 from pathlib import Path
 from shutil import copy
 from tempfile import TemporaryDirectory
@@ -167,10 +167,10 @@ def test_list_directory(self):
         # call the function
         with TemporaryDirectory() as temp:
             # copy required files
-            with path("tests.resources.media", "dummy.ass") as file:
+            with as_file(files("tests.resources.media").joinpath("dummy.ass")) as file:
                 copy(file, temp)
 
-            with path("tests.resources.media", "dummy.mkv") as file:
+            with as_file(files("tests.resources.media").joinpath("dummy.mkv")) as file:
                 copy(file, temp)
 
             with self.assertLogs("dakara_feeder.directory", "DEBUG"):
@@ -188,38 +188,40 @@ class GetMainTypeTestCase(TestCase):
 
     def test_video(self):
         """Test the common video files."""
-        with path("tests.resources.filetype", "file.avi") as file:
+        with as_file(files("tests.resources.filetype").joinpath("file.avi")) as file:
             self.assertEqual(get_main_type(file), "video")
 
-        with path("tests.resources.filetype", "file.mkv") as file:
+        with as_file(files("tests.resources.filetype").joinpath("file.mkv")) as file:
             self.assertEqual(get_main_type(file), "video")
 
-        with path("tests.resources.filetype", "file_upper.MKV") as file:
+        with as_file(
+            files("tests.resources.filetype").joinpath("file_upper.MKV")
+        ) as file:
             self.assertEqual(get_main_type(file), "video")
 
-        with path("tests.resources.filetype", "file.mp4") as file:
+        with as_file(files("tests.resources.filetype").joinpath("file.mp4")) as file:
             self.assertEqual(get_main_type(file), "video")
 
     def test_audio(self):
         """Test the common audio files."""
-        with path("tests.resources.filetype", "file.flac") as file:
+        with as_file(files("tests.resources.filetype").joinpath("file.flac")) as file:
             self.assertEqual(get_main_type(file), "audio")
 
-        with path("tests.resources.filetype", "file.mp3") as file:
+        with as_file(files("tests.resources.filetype").joinpath("file.mp3")) as file:
             self.assertEqual(get_main_type(file), "audio")
 
-        with path("tests.resources.filetype", "file.ogg") as file:
+        with as_file(files("tests.resources.filetype").joinpath("file.ogg")) as file:
             self.assertEqual(get_main_type(file), "audio")
 
     def test_subtitle(self):
         """Test the common subtitles files."""
-        with path("tests.resources.filetype", "file.ass") as file:
+        with as_file(files("tests.resources.filetype").joinpath("file.ass")) as file:
             self.assertIsNone(get_main_type(file))
 
-        with path("tests.resources.filetype", "file.ssa") as file:
+        with as_file(files("tests.resources.filetype").joinpath("file.ssa")) as file:
             self.assertIsNone(get_main_type(file))
 
-        with path("tests.resources.filetype", "file.srt") as file:
+        with as_file(files("tests.resources.filetype").joinpath("file.srt")) as file:
             self.assertIsNone(get_main_type(file))
 
 

tests/unit/test_subtitle_parsing.py

@@ -1,4 +1,4 @@
-from importlib.resources import path
+from importlib.resources import as_file, files
 from pathlib import Path
 from unittest import TestCase
 from unittest.mock import patch
@@ -16,7 +16,7 @@ class TXTSubtitleParserTestCase(TestCase):
 
     def test_parse(self):
         """Parse text file."""
-        with path("tests.resources.subtitles", "plain.txt") as file:
+        with as_file(files("tests.resources.subtitles").joinpath("plain.txt")) as file:
             parser = TXTSubtitleParser.parse(file)
             self.assertEqual(parser.get_lyrics(), file.read_text())
 
@@ -38,13 +38,15 @@ def generic_test_subtitle(self, file_name):
         This method is called from other tests methods.
         """
         # open and parse given file
-        with path("tests.resources.subtitles", file_name) as file:
+        with as_file(files("tests.resources.subtitles").joinpath(file_name)) as file:
             parser = Pysubs2SubtitleParser.parse(file)
             lyrics = parser.get_lyrics()
             lines = lyrics.splitlines()
 
         # open expected result
-        with path("tests.resources.subtitles", file_name + "_expected") as file:
+        with as_file(
+            files("tests.resources.subtitles").joinpath(file_name + "_expected")
+        ) as file:
             expected_lines = file.read_text().splitlines()
 
         # check against expected file
@@ -57,14 +59,16 @@ def test_simple(self):
     def test_simple_string(self):
         """Test simple ass file from string."""
         # open and parse given file
-        with path("tests.resources.subtitles", "simple.ass") as file:
+        with as_file(files("tests.resources.subtitles").joinpath("simple.ass")) as file:
             content = file.read_text()
             parser = Pysubs2SubtitleParser.parse_string(content)
             lyrics = parser.get_lyrics()
             lines = lyrics.splitlines()
 
         # open expected result
-        with path("tests.resources.subtitles", "simple.ass_expected") as file:
+        with as_file(
+            files("tests.resources.subtitles").joinpath("simple.ass_expected")
+        ) as file:
             expected_lines = file.read_text().splitlines()
 
         # check against expected file