danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[FEATURE] Add reversed date variables (#192)

Browse source
This commit is contained in:
Jesse Bannon 2022-08-23 22:32:41 -07:00 committed by GitHub
parent f8386daadd
commit 9b224b7fc6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 105 additions and 133 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
src/ytdl_sub/entries/variables/entry_variables.py
View file

@ -10,6 +10,12 @@ from ytdl_sub.entries.base_entry import BaseEntry
# pylint: disable=no-member
def _pad(num):
if num < 10:
return f"0{num}"
return str(num)
class SourceVariables:
"""
Source variables are ``{variables}`` that contain metadata from downloaded media.
@ -142,6 +148,37 @@ class EntryVariables(SourceVariables):
"""
return int(str(self.upload_year)[-2:])
@property
def upload_year_truncated_reversed(self) -> int:
"""
Returns
-------
int
The upload year truncated, but reversed using ``100 - {upload_year_truncated}``, i.e.
2022 returns ``100 - 22`` = ``78``
"""
return 100 - self.upload_year_truncated
@property
def upload_month_reversed(self) -> int:
"""
Returns
-------
int
The upload month, but reversed using ``13 - {upload_month}``, i.e. March returns ``10``
"""
return 13 - self.upload_month
@property
def upload_month_reversed_padded(self) -> str:
"""
Returns
-------
str
The reversed upload month, but padded. i.e. November returns "02"
"""
return _pad(self.upload_month_reversed)
@property
def upload_month_padded(self) -> str:
"""
@ -182,6 +219,35 @@ class EntryVariables(SourceVariables):
"""
return int(self.upload_day_padded.lstrip("0"))
@property
def upload_day_reversed(self) -> int:
"""
Returns
-------
int
The upload day, but reversed using ``{total_days_in_month} + 1 - {upload_day}``,
i.e. August 8th would have upload_day_reversed of ``31 + 1 - 8`` = ``24``
"""
total_days_in_month: int = 30
if self.upload_month in [1, 3, 5, 7, 8, 10, 12]:
total_days_in_month = 31
elif self.upload_month == 2:
total_days_in_month = 28
if self.upload_year % 4 == 0: # leap year
total_days_in_month = 29
return total_days_in_month + 1 - self.upload_day
@property
def upload_day_reversed_padded(self) -> str:
"""
Returns
-------
str
The reversed upload day, but padded. i.e. August 30th returns "02".
"""
return _pad(self.upload_day_reversed)
@property
def upload_date_standardized(self) -> str:
"""

72
tests/unit/entries/conftest.py
View file

@ -4,12 +4,6 @@ from ytdl_sub.entries.entry import Entry
from ytdl_sub.validators.string_formatter_validators import StringFormatterValidator
def _pad(num):
if num < 10:
return f"0{num}"
return str(num)
@pytest.fixture
def uid():
return "abc123"
@ -26,23 +20,8 @@ def title():
@pytest.fixture
def upload_year():
return 2021
@pytest.fixture
def upload_month():
return 1
@pytest.fixture
def upload_day():
return 12
@pytest.fixture
def upload_date(upload_year, upload_month, upload_day):
return f"{upload_year}{_pad(upload_month)}{_pad(upload_day)}"
def upload_date():
return "20210112"
@pytest.fixture
@ -72,10 +51,7 @@ def mock_entry_to_dict(
ext,
extractor,
upload_date,
upload_year,
thumbnail_ext,
upload_month,
upload_day,
):
return {
"uid": uid,
@ -84,13 +60,18 @@ def mock_entry_to_dict(
"ext": ext,
"extractor": extractor,
"upload_date": upload_date,
"upload_date_standardized": f"{upload_year}-{_pad(upload_month)}-{_pad(upload_day)}",
"upload_year": upload_year,
"upload_date_standardized": "2021-01-12",
"upload_year": 2021,
"upload_year_truncated": 21,
"upload_month": upload_month,
"upload_month_padded": _pad(upload_month),
"upload_day": upload_day,
"upload_day_padded": _pad(upload_day),
"upload_year_truncated_reversed": 79,
"upload_month": 1,
"upload_month_padded": "01",
"upload_month_reversed": 12,
"upload_month_reversed_padded": "12",
"upload_day": 12,
"upload_day_padded": "12",
"upload_day_reversed": 20,
"upload_day_reversed_padded": "20",
"thumbnail_ext": thumbnail_ext,
}
@ -112,33 +93,6 @@ def mock_entry(mock_entry_kwargs):
return Entry(entry_dict=mock_entry_kwargs, working_directory=".")
@pytest.fixture
def validate_entry_properties(
uid,
title,
upload_date,
upload_year,
ext,
extractor,
thumbnail_ext,
download_file_name,
download_thumbnail_name,
):
def _validate_entry_properties(entry: Entry):
assert entry.uid == uid
assert entry.title == title
assert entry.title_sanitized == title
assert entry.upload_date == upload_date
assert entry.upload_year == upload_year
assert entry.ext == ext
assert entry.thumbnail_ext == thumbnail_ext
assert entry.extractor == extractor
return True
return _validate_entry_properties
@pytest.fixture
def validate_entry_dict_contains_valid_formatters():
def _validate_entry_dict_contains_valid_formatters(entry: Entry):

26
tests/unit/entries/test_entry.py
View file

@ -2,13 +2,6 @@ import pytest
class TestEntry(object):
def test_entry_properties(
self,
mock_entry,
validate_entry_properties,
):
assert validate_entry_properties(mock_entry)
def test_entry_to_dict(self, mock_entry, mock_entry_to_dict):
assert mock_entry.to_dict() == mock_entry_to_dict
@ -24,3 +17,22 @@ class TestEntry(object):
assert mock_entry.kwargs_contains(key) is False
with pytest.raises(KeyError, match=expected_error_msg):
mock_entry.kwargs(key)
@pytest.mark.parametrize(
"upload_date, year_rev, month_rev, day_rev, month_rev_pad, day_rev_pad",
[
("20000228", 100, 11, 2, "11", "02"),
("20200808", 80, 5, 24, "05", "24"),
],
)
def test_entry_reverse_variables(
self, mock_entry, upload_date, year_rev, month_rev, day_rev, month_rev_pad, day_rev_pad
):
mock_entry._kwargs["upload_date"] = upload_date
assert mock_entry.upload_year_truncated_reversed == year_rev
assert mock_entry.upload_month_reversed == month_rev
assert mock_entry.upload_day_reversed == day_rev
assert mock_entry.upload_month_reversed_padded == month_rev_pad
assert mock_entry.upload_day_reversed_padded == day_rev_pad

74
tests/unit/entries/test_soundcloud_entries.py
View file

@ -3,50 +3,22 @@ import pytest
from ytdl_sub.entries.soundcloud import SoundcloudTrack
@pytest.fixture
def track_number():
return 1
@pytest.fixture
def track_number_padded():
return "01"
@pytest.fixture
def track_count():
return 1
@pytest.fixture
def url():
return "soundcloud.com/artist/track-asdfasdf"
@pytest.fixture
def is_premiere():
return False
@pytest.fixture
def mock_soundcloud_track_to_dict(
mock_entry_to_dict,
title,
upload_year,
track_number,
track_number_padded,
is_premiere,
track_count,
):
def mock_soundcloud_track_to_dict(mock_entry_to_dict):
return dict(
mock_entry_to_dict,
**{
"track_number": track_number,
"track_number_padded": track_number_padded,
"album": title,
"album_sanitized": title,
"album_year": upload_year,
"track_count": track_count,
"track_number": 1,
"track_number_padded": "01",
"album": mock_entry_to_dict["title"],
"album_sanitized": mock_entry_to_dict["title_sanitized"],
"album_year": mock_entry_to_dict["upload_year"],
"track_count": 1,
}
)
@ -61,39 +33,7 @@ def mock_soundcloud_track(mock_soundcloud_track_kwargs):
return SoundcloudTrack(entry_dict=mock_soundcloud_track_kwargs, working_directory=".")
@pytest.fixture
def validate_soundcloud_track_properties(
validate_entry_properties,
title,
upload_year,
track_number,
track_number_padded,
is_premiere,
track_count,
):
def _validate_soundcloud_track_properties(soundcloud_track: SoundcloudTrack):
assert validate_entry_properties(soundcloud_track)
assert soundcloud_track.track_number == track_number
assert soundcloud_track.track_number_padded == track_number_padded
assert soundcloud_track.album == title
assert soundcloud_track.album_sanitized == title
assert soundcloud_track.album_year == upload_year
assert soundcloud_track.track_count == track_count
assert soundcloud_track.is_premiere() == is_premiere
return True
return _validate_soundcloud_track_properties
class TestSoundcloudTrack(object):
def test_properties(
self,
mock_soundcloud_track,
validate_soundcloud_track_properties,
):
assert validate_soundcloud_track_properties(mock_soundcloud_track)
def test_to_dict(self, mock_soundcloud_track, mock_soundcloud_track_to_dict):
assert mock_soundcloud_track.to_dict() == mock_soundcloud_track_to_dict