From ba2ab25c2c4dce46618a8c7b4e60c5773d902a37 Mon Sep 17 00:00:00 2001 From: Serene-Arc Date: Sat, 20 Mar 2021 14:05:07 +1000 Subject: [PATCH] Rename options --- README.md | 4 ++-- bulkredditdownloader/__main__.py | 4 ++-- bulkredditdownloader/configuration.py | 4 ++-- bulkredditdownloader/downloader.py | 2 +- bulkredditdownloader/tests/test_downloader.py | 20 +++++++++---------- .../tests/test_integration.py | 2 +- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 90fed77..7c825d5 100644 --- a/README.md +++ b/README.md @@ -99,11 +99,11 @@ The following options apply only to the `download` command. This command downloa - This is calculated by MD5 hash - `--search-existing` - This will make the BDFR compile the hashes for every file in `directory` and store them to remove duplicates if `--no-dupes` is also supplied -- `--set-file-scheme` +- `--file-scheme` - Sets the scheme for files - Default is `{REDDITOR}_{TITLE}_{POSTID}` - See[Folder and File Name Schemes](#folder-and-file-name-schemes) for more details -- `--set-folder-scheme` +- `--folder-scheme` - Sets the scheme for folders - Default is `{SUBREDDIT}` - See[Folder and File Name Schemes](#folder-and-file-name-schemes) for more details diff --git a/bulkredditdownloader/__main__.py b/bulkredditdownloader/__main__.py index 1e40bb0..3d87a72 100644 --- a/bulkredditdownloader/__main__.py +++ b/bulkredditdownloader/__main__.py @@ -46,8 +46,8 @@ def cli(): @click.option('--make-hard-links', is_flag=True, default=None) @click.option('--no-dupes', is_flag=True, default=None) @click.option('--search-existing', is_flag=True, default=None) -@click.option('--set-file-scheme', default=None, type=str) -@click.option('--set-folder-scheme', default=None, type=str) +@click.option('--file-scheme', default=None, type=str) +@click.option('--folder-scheme', default=None, type=str) @click.option('--skip', default=None, multiple=True) @click.option('--skip-domain', default=None, multiple=True) @_add_common_options diff --git a/bulkredditdownloader/configuration.py b/bulkredditdownloader/configuration.py index 7c298b4..1227590 100644 --- a/bulkredditdownloader/configuration.py +++ b/bulkredditdownloader/configuration.py @@ -20,8 +20,8 @@ class Configuration(Namespace): self.saved: bool = False self.search: Optional[str] = None self.search_existing: bool = False - self.set_file_scheme: str = '{REDDITOR}_{TITLE}_{POSTID}' - self.set_folder_scheme: str = '{SUBREDDIT}' + self.file_scheme: str = '{REDDITOR}_{TITLE}_{POSTID}' + self.folder_scheme: str = '{SUBREDDIT}' self.skip: list[str] = [] self.skip_domain: list[str] = [] self.sort: str = 'hot' diff --git a/bulkredditdownloader/downloader.py b/bulkredditdownloader/downloader.py index dc9c301..f536adb 100644 --- a/bulkredditdownloader/downloader.py +++ b/bulkredditdownloader/downloader.py @@ -289,7 +289,7 @@ class RedditDownloader: return True def _create_file_name_formatter(self) -> FileNameFormatter: - return FileNameFormatter(self.args.set_file_scheme, self.args.set_folder_scheme) + return FileNameFormatter(self.args.file_scheme, self.args.folder_scheme) def _create_time_filter(self) -> RedditTypes.TimeType: try: diff --git a/bulkredditdownloader/tests/test_downloader.py b/bulkredditdownloader/tests/test_downloader.py index e263a5d..9b05c9e 100644 --- a/bulkredditdownloader/tests/test_downloader.py +++ b/bulkredditdownloader/tests/test_downloader.py @@ -101,8 +101,8 @@ def test_create_sort_filter(test_sort: str, expected: str, downloader_mock: Magi ('{POSTID}', ''), )) def test_create_file_name_formatter(test_file_scheme: str, test_folder_scheme: str, downloader_mock: MagicMock): - downloader_mock.args.set_file_scheme = test_file_scheme - downloader_mock.args.set_folder_scheme = test_folder_scheme + downloader_mock.args.file_scheme = test_file_scheme + downloader_mock.args.folder_scheme = test_folder_scheme result = RedditDownloader._create_file_name_formatter(downloader_mock) assert isinstance(result, FileNameFormatter) @@ -116,8 +116,8 @@ def test_create_file_name_formatter(test_file_scheme: str, test_folder_scheme: s ('test', '{SUBREDDIT}'), )) def test_create_file_name_formatter_bad(test_file_scheme: str, test_folder_scheme: str, downloader_mock: MagicMock): - downloader_mock.args.set_file_scheme = test_file_scheme - downloader_mock.args.set_folder_scheme = test_folder_scheme + downloader_mock.args.file_scheme = test_file_scheme + downloader_mock.args.folder_scheme = test_folder_scheme with pytest.raises(BulkDownloaderException): RedditDownloader._create_file_name_formatter(downloader_mock) @@ -283,7 +283,7 @@ def test_download_submission( tmp_path: Path): downloader_mock.reddit_instance = reddit_instance downloader_mock.download_filter.check_url.return_value = True - downloader_mock.args.set_folder_scheme = '' + downloader_mock.args.folder_scheme = '' downloader_mock.file_name_formatter = RedditDownloader._create_file_name_formatter(downloader_mock) downloader_mock.download_directory = tmp_path submission = downloader_mock.reddit_instance.submission(id=test_submission_id) @@ -302,7 +302,7 @@ def test_download_submission_file_exists( setup_logging(3) downloader_mock.reddit_instance = reddit_instance downloader_mock.download_filter.check_url.return_value = True - downloader_mock.args.set_folder_scheme = '' + downloader_mock.args.folder_scheme = '' downloader_mock.file_name_formatter = RedditDownloader._create_file_name_formatter(downloader_mock) downloader_mock.download_directory = tmp_path submission = downloader_mock.reddit_instance.submission(id='m1hqw6') @@ -324,7 +324,7 @@ def test_download_submission_hash_exists( setup_logging(3) downloader_mock.reddit_instance = reddit_instance downloader_mock.download_filter.check_url.return_value = True - downloader_mock.args.set_folder_scheme = '' + downloader_mock.args.folder_scheme = '' downloader_mock.args.no_dupes = True downloader_mock.file_name_formatter = RedditDownloader._create_file_name_formatter(downloader_mock) downloader_mock.download_directory = tmp_path @@ -376,8 +376,8 @@ def test_mark_hard_link(downloader_mock: MagicMock, tmp_path: Path, reddit_insta downloader_mock.reddit_instance = reddit_instance downloader_mock.args.make_hard_links = True downloader_mock.download_directory = tmp_path - downloader_mock.args.set_folder_scheme = '' - downloader_mock.args.set_file_scheme = '{POSTID}' + downloader_mock.args.folder_scheme = '' + downloader_mock.args.file_scheme = '{POSTID}' downloader_mock.file_name_formatter = RedditDownloader._create_file_name_formatter(downloader_mock) submission = downloader_mock.reddit_instance.submission(id='m1hqw6') original = Path(tmp_path, 'm1hqw6.png') @@ -385,7 +385,7 @@ def test_mark_hard_link(downloader_mock: MagicMock, tmp_path: Path, reddit_insta RedditDownloader._download_submission(downloader_mock, submission) assert original.exists() - downloader_mock.args.set_file_scheme = 'test2_{POSTID}' + downloader_mock.args.file_scheme = 'test2_{POSTID}' downloader_mock.file_name_formatter = RedditDownloader._create_file_name_formatter(downloader_mock) RedditDownloader._download_submission(downloader_mock, submission) test_file_1_stats = original.stat() diff --git a/bulkredditdownloader/tests/test_integration.py b/bulkredditdownloader/tests/test_integration.py index 600e983..a50d7f7 100644 --- a/bulkredditdownloader/tests/test_integration.py +++ b/bulkredditdownloader/tests/test_integration.py @@ -115,7 +115,7 @@ def test_cli_download_user_data_good(test_args: list[str], tmp_path: Path): @pytest.mark.authenticated @pytest.mark.skipif(Path('test_config.cfg') is False, reason='A test config file is required for integration tests') @pytest.mark.parametrize('test_args', ( - ['--user', 'me', '-L', 10, '--set-folder-scheme', ''], + ['--user', 'me', '-L', 10, '--folder-scheme', ''], )) def test_cli_download_user_data_bad_me_unauthenticated(test_args: list[str], tmp_path: Path): runner = CliRunner()