From e5b321136b2e922bad7656a7ee4a894960ffafaf Mon Sep 17 00:00:00 2001 From: Joakim Soderlund Date: Wed, 13 Mar 2019 11:51:35 +0100 Subject: [PATCH] Allow string path arguments in directory fetcher --- fimfarchive/fetchers/directory.py | 11 ++++++----- fimfarchive/utils.py | 19 +++++++++++++++++++ tests/test_utils.py | 24 +++++++++++++++++++++++- 3 files changed, 48 insertions(+), 6 deletions(-) diff --git a/fimfarchive/fetchers/directory.py b/fimfarchive/fetchers/directory.py index 025f009..d6d143f 100644 --- a/fimfarchive/fetchers/directory.py +++ b/fimfarchive/fetchers/directory.py @@ -25,11 +25,12 @@ Directory fetcher. import json from itertools import chain from pathlib import Path -from typing import Any, Dict, Iterable, Iterator, Optional, Set +from typing import Any, Dict, Iterable, Iterator, Optional, Set, Union from fimfarchive.exceptions import InvalidStoryError, StorySourceError from fimfarchive.flavors import Flavor from fimfarchive.stories import Story +from fimfarchive.utils import get_path from .base import Fetcher @@ -48,8 +49,8 @@ class DirectoryFetcher(Fetcher): def __init__( self, - meta_path: Path = None, - data_path: Path = None, + meta_path: Union[Path, str] = None, + data_path: Union[Path, str] = None, flavors: Iterable[Flavor] = tuple(), ) -> None: """ @@ -60,8 +61,8 @@ class DirectoryFetcher(Fetcher): data: The directory for story data. flavors: The flavors to add to stories. """ - self.meta_path = meta_path - self.data_path = data_path + self.meta_path = get_path(meta_path) + self.data_path = get_path(data_path) self.length: Optional[int] = None self.flavors = frozenset(flavors) diff --git a/fimfarchive/utils.py b/fimfarchive/utils.py index 7194d93..58d728f 100644 --- a/fimfarchive/utils.py +++ b/fimfarchive/utils.py @@ -28,6 +28,7 @@ import shutil from functools import partial from importlib import import_module from importlib_resources import read_binary, read_text +from pathlib import Path from typing import ( cast, Any, Callable, Dict, Iterator, Optional, Tuple, Type, TypeVar, Union, @@ -42,8 +43,10 @@ from fimfarchive.stories import Story __all__ = ( 'Empty', 'PersistedDict', + 'ResourceLoader', 'find_compressor', 'find_flavor', + 'get_path', 'tqdm', ) @@ -203,6 +206,22 @@ def find_flavor(story: Story, flavor: Type[F]) -> Optional[F]: return None +def get_path(source: Union[None, Path, str]) -> Optional[Path]: + """ + Creates a path from an object, if one is supplied. + + Args: + source: Object to create a path from. + + Returns: + A resolved path instance, or None. + """ + if source is None: + return None + + return Path(source).resolve() + + class ResourceLoader: """ Loads resources from a package. diff --git a/tests/test_utils.py b/tests/test_utils.py index d195bba..86d19b6 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -24,12 +24,16 @@ Utility tests. import json import os +from pathlib import Path from unittest.mock import call, patch import pytest from fimfarchive.flavors import DataFormat, MetaFormat, MetaPurity -from fimfarchive.utils import find_flavor, Empty, JayWalker, PersistedDict +from fimfarchive.utils import ( + find_flavor, get_path, + Empty, JayWalker, PersistedDict +) class TestEmpty: @@ -291,3 +295,21 @@ class TestFindFlavor: """ found = find_flavor(story, DataFormat) assert found is None + + +class TestGetPath: + """ + get_path tests. + """ + + @pytest.mark.parametrize('source,target', ( + (None, None), + ('', Path().resolve()), + ('alpaca', Path('alpaca').resolve()), + (Path('alpaca'), Path('alpaca').resolve()), + )) + def test_return_values(self, source, target): + """ + Tests function returns the correct value. + """ + assert target == get_path(source)