Skip to content

Parse datetime strings to timezone aware objects #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tkdrob wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Parse datetime strings to timezone aware objects #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f20ea70
Parse datetime strings to timezone aware objects
tkdrob Sep 7, 2024
13e7625
lint
tkdrob Sep 7, 2024
b6b82b8
fix utc import
tkdrob Sep 7, 2024
cb7e6cc
pylint
tkdrob Sep 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 4 additions & 21 deletions aiopyarr/models/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from __future__ import annotations

from dataclasses import dataclass
from datetime import date, datetime
from datetime import datetime
from enum import Enum
from typing import Any

Expand All @@ -12,7 +12,6 @@
from ..const import ATTR_DATA
from .const import (
CONVERT_TO_BOOL,
CONVERT_TO_DATE,
CONVERT_TO_DATETIME,
CONVERT_TO_ENUM,
CONVERT_TO_FLOAT,
Expand All @@ -21,26 +20,15 @@
)


def get_datetime(
_input: datetime | str | None, utc: bool = False
) -> datetime | str | int | None:
def get_datetime(_input: datetime | str | None) -> datetime | str | int | None:
"""Convert input to datetime object."""
if isinstance(_input, str):
if _input.isnumeric():
return int(_input)
if utc:
return ciso8601.parse_datetime(_input)
return ciso8601.parse_datetime_as_naive(_input)
return ciso8601.parse_datetime(_input)
return _input


def get_date(_input: datetime | str | None) -> date | None:
"""Convert input to date object."""
if (result := get_datetime(_input)) and isinstance(result, datetime):
return result.date()
return None


def get_enum_value(val: str) -> str | Enum:
"""Convert input to the correct enum."""
for protocol in ProtocolType:
Expand Down Expand Up @@ -95,12 +83,7 @@ def __init__(
if key == ATTR_DATA:
value = generate_data(value, datatype)
elif key in CONVERT_TO_DATETIME:
if key == "airDateUtc":
value = get_datetime(value, utc=True)
else:
value = get_datetime(value)

@allenporter allenporter Nov 7, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What format are the dates returned from the API in this case? and what does ciso8601.parse_datetime do with them?

I assume the logic now is something like:

  • if its a utc date, you get a utc date (then assuming .date() wil be correct)
  • if its a timesamp aware date, you get a timestamp aware date. (then assuming .date() wil be correct)
  • if its no timezone datetime, you get a utc datetime (probably reasonable, then .date() will be correct)

@allenporter allenporter Nov 7, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

resolved offline.

elif key in CONVERT_TO_DATE:
value = get_date(value)
value = get_datetime(value)
elif key in CONVERT_TO_ENUM:
value = get_enum_value(value)
elif key in CONVERT_TO_FLOAT and value is not None:
Expand Down
3 changes: 2 additions & 1 deletion aiopyarr/models/const.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,14 @@
"tvRageId",
)

CONVERT_TO_DATE = (
RELEASE_TYPES = (
"digitalRelease",
"physicalRelease",
"inCinemas",
)

CONVERT_TO_DATETIME = (
*RELEASE_TYPES,
"added",
"airDate",
"airDateUtc",
Expand Down
17 changes: 13 additions & 4 deletions aiopyarr/models/radarr_common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,17 @@
from __future__ import annotations

from dataclasses import dataclass, field
from datetime import date, timedelta
from datetime import date, datetime, timedelta

try:
from datetime import UTC
except ImportError:
from datetime import timezone

UTC = timezone.utc

from .base import BaseModel
from .const import CONVERT_TO_DATE
from .const import RELEASE_TYPES
from .request_common import (
_Common3,
_Common5,
Expand Down Expand Up @@ -141,10 +148,12 @@ def __post_init__(self):
self.images = [_RadarrMovieImages(image) for image in self.images or []]
self.ratings = _RadarrMovieRatings(self.ratings)

def releaseDateType(self, release: date = date.today()) -> tuple[date, str]:
def releaseDateType(
self, release: datetime = datetime.now(UTC)
) -> tuple[datetime, str]:
"""Return release date and type matching/closest to supplied date."""
delta = timedelta(days=999999999)
for _type in CONVERT_TO_DATE:
for _type in RELEASE_TYPES:
try:
if (_date := getattr(self, _type)) and abs(release - _date) < delta:
delta = release - _date
Expand Down
97 changes: 61 additions & 36 deletions tests/test_lidarr.py
View file
Open in desktop

Large diffs are not rendered by default.

86 changes: 48 additions & 38 deletions tests/test_radarr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,17 @@
# pylint:disable=line-too-long, too-many-lines, too-many-statements
from datetime import date, datetime

try:
from datetime import UTC
except ImportError:
from datetime import timezone

UTC = timezone.utc

from aresponses.main import ResponsesMockServer as Server
import pytest

from aiopyarr.exceptions import ArrException
from aiopyarr.models.base import get_date
from aiopyarr.models.const import ProtocolType
from aiopyarr.models.radarr import (
RadarrCommands,
Expand Down Expand Up @@ -56,7 +62,7 @@ async def test_async_get_blocklist(
assert isinstance(data.totalRecords, int)
assert isinstance(data.records[0].movieId, int)
assert data.records[0].sourceTitle == "string"
assert data.records[0].date == datetime(2021, 9, 19, 14, 24, 13)
assert data.records[0].date == datetime(2021, 9, 19, 14, 24, 13, tzinfo=UTC)
assert isinstance(data.records[0].id, int)
assert data.records[0].indexer == "string"
assert data.records[0].protocol is ProtocolType.UNKNOWN
Expand Down Expand Up @@ -136,7 +142,7 @@ async def test_async_get_blocklist_movie(
assert spec.fields[0].value == "string"
assert spec.fields[0].type == "string"
assert spec.fields[0].advanced is True
assert data[0].date == datetime(2019, 4, 10, 15, 9, 11)
assert data[0].date == datetime(2019, 4, 10, 15, 9, 11, tzinfo=UTC)
assert isinstance(data[0].id, int)
assert data[0].indexer == "string"
assert data[0].protocol is ProtocolType.UNKNOWN
Expand Down Expand Up @@ -170,10 +176,10 @@ async def test_async_get_calendar(
assert isinstance(data[0].sizeOnDisk, int)
assert data[0].status == "string"
assert data[0].overview == "string"
assert data[0].physicalRelease == date(2021, 12, 3)
assert data[0].digitalRelease == date(2020, 8, 11)
assert data[0].releaseDateType(date(2021, 1, 12)) == (
date(2020, 8, 11),
assert data[0].physicalRelease == datetime(2021, 12, 3, 0, 0, tzinfo=UTC)
assert data[0].digitalRelease == datetime(2020, 8, 11, tzinfo=UTC)
assert data[0].releaseDateType(datetime(2021, 1, 12, tzinfo=UTC)) == (
datetime(2020, 8, 11, tzinfo=UTC),
"digitalRelease",
)
assert data[0].images[0].coverType == ImageType.POSTER.value
Expand All @@ -196,7 +202,7 @@ async def test_async_get_calendar(
assert isinstance(data[0].titleSlug, int)
assert data[0].genres == ["string"]
assert data[0].tags == []
assert data[0].added == datetime(2020, 7, 16, 13, 25, 37)
assert data[0].added == datetime(2020, 7, 16, 13, 25, 37, tzinfo=UTC)
assert isinstance(data[0].ratings.imdb.votes, int)
assert isinstance(data[0].ratings.imdb.value, float)
assert data[0].ratings.imdb.type == "string"
Expand All @@ -213,7 +219,7 @@ async def test_async_get_calendar(
assert data[0].movieFile.relativePath == "string"
assert data[0].movieFile.path == "string"
assert isinstance(data[0].movieFile.size, int)
assert data[0].movieFile.dateAdded == datetime(2021, 6, 1, 4, 8, 20)
assert data[0].movieFile.dateAdded == datetime(2021, 6, 1, 4, 8, 20, tzinfo=UTC)
assert data[0].movieFile.sceneName == "string"
assert isinstance(data[0].movieFile.indexerFlags, int)
assert isinstance(data[0].movieFile.quality.quality.id, int)
Expand Down Expand Up @@ -328,7 +334,7 @@ async def test_async_get_history(
assert spec.fields[0].type == "string"
assert spec.fields[0].advanced is True
assert data.records[0].qualityCutoffNotMet is True
assert data.records[0].date == datetime(2020, 2, 20, 21, 34, 52)
assert data.records[0].date == datetime(2020, 2, 20, 21, 34, 52, tzinfo=UTC)
assert data.records[0].downloadId == "string"
assert data.records[0].eventType == RadarrEventType.GRABBED.name.lower()
assert isinstance(data.records[0].data.fileId, int)
Expand Down Expand Up @@ -446,11 +452,11 @@ async def test_async_get_import_list_movies(
assert data[0].sortTitle == "string"
assert data[0].status == "released"
assert data[0].overview == "string"
assert data[0].inCinemas == date(2018, 3, 9)
assert data[0].physicalRelease == date(2018, 6, 10)
assert data[0].digitalRelease == date(2018, 5, 25)
assert data[0].releaseDateType(date(2018, 6, 10)) == (
date(2018, 6, 10),
assert data[0].inCinemas == datetime(2018, 3, 9, tzinfo=UTC)
assert data[0].physicalRelease == datetime(2018, 6, 10, tzinfo=UTC)
assert data[0].digitalRelease == datetime(2018, 5, 25, tzinfo=UTC)
assert data[0].releaseDateType(datetime(2018, 6, 10, tzinfo=UTC)) == (
datetime(2018, 6, 10, tzinfo=UTC),
"physicalRelease",
)
assert data[0].images[0].coverType == ImageType.POSTER.value
Expand Down Expand Up @@ -683,10 +689,10 @@ async def test_async_get_movie(aresponses: Server, radarr_client: RadarrClient)
assert data.sortTitle == "string"
assert isinstance(data.sizeOnDisk, int)
assert data.overview == "string"
assert data.inCinemas == date(2020, 11, 6)
assert data.physicalRelease == date(2019, 3, 19)
assert data.releaseDateType(date(2019, 1, 1)) == (
date(2019, 3, 19),
assert data.inCinemas == datetime(2020, 11, 6, tzinfo=UTC)
assert data.physicalRelease == datetime(2019, 3, 19, tzinfo=UTC)
assert data.releaseDateType(datetime(2019, 1, 1, tzinfo=UTC)) == (
datetime(2019, 3, 19, tzinfo=UTC),
"physicalRelease",
)
assert data.images[0].coverType == ImageType.POSTER.value
Expand All @@ -712,7 +718,7 @@ async def test_async_get_movie(aresponses: Server, radarr_client: RadarrClient)
assert data.certification == "string"
assert data.genres == ["string"]
assert isinstance(data.tags[0], int)
assert data.added == datetime(2018, 12, 28, 5, 56, 49)
assert data.added == datetime(2018, 12, 28, 5, 56, 49, tzinfo=UTC)
assert isinstance(data.ratings.imdb.votes, int)
assert isinstance(data.ratings.imdb.value, float)
assert data.ratings.imdb.type == "string"
Expand All @@ -729,7 +735,7 @@ async def test_async_get_movie(aresponses: Server, radarr_client: RadarrClient)
assert data.movieFile.relativePath == "string"
assert data.movieFile.path == "string"
assert isinstance(data.movieFile.size, int)
assert data.movieFile.dateAdded == datetime(2020, 11, 26, 2, 0, 35)
assert data.movieFile.dateAdded == datetime(2020, 11, 26, 2, 0, 35, tzinfo=UTC)
assert data.movieFile.indexerFlags == 1
assert isinstance(data.movieFile.quality.quality.id, int)
assert data.movieFile.quality.quality.name == "string"
Expand Down Expand Up @@ -831,7 +837,7 @@ async def test_async_lookup_movie_files(
assert data.relativePath == "string"
assert data.path == "string"
assert isinstance(data.size, int)
assert data.dateAdded == datetime(2018, 12, 28, 6, 35, 27)
assert data.dateAdded == datetime(2018, 12, 28, 6, 35, 27, tzinfo=UTC)
assert isinstance(data.indexerFlags, int)
assert isinstance(data.quality.quality.id, int)
assert data.quality.quality.name == "string"
Expand Down Expand Up @@ -980,7 +986,9 @@ async def test_async_get_queue(aresponses: Server, radarr_client: RadarrClient)
assert data.records[0].title == "string"
assert data.records[0].sizeleft > 0
assert data.records[0].timeleft == "00:00:20"
assert data.records[0].estimatedCompletionTime == datetime(2020, 1, 21, 0, 1, 59)
assert data.records[0].estimatedCompletionTime == datetime(
2020, 1, 21, 0, 1, 59, tzinfo=UTC
)
assert data.records[0].status == "string"
assert data.records[0].trackedDownloadStatus == "string"
assert data.records[0].trackedDownloadState == "downloading"
Expand Down Expand Up @@ -1107,7 +1115,9 @@ async def test_async_get_queue_details(
assert data[0].title == "string"
assert data[0].sizeleft == 0
assert data[0].timeleft == "string"
assert data[0].estimatedCompletionTime == datetime(2020, 1, 21, 0, 1, 59)
assert data[0].estimatedCompletionTime == datetime(
2020, 1, 21, 0, 1, 59, tzinfo=UTC
)
assert data[0].status == "string"
assert data[0].trackedDownloadStatus == "string"
assert data[0].trackedDownloadState == "string"
Expand Down Expand Up @@ -1205,10 +1215,13 @@ async def test_async_parse(aresponses: Server, radarr_client: RadarrClient) -> N
assert isinstance(data.movie.sizeOnDisk, int)
assert data.movie.status == "string"
assert data.movie.overview == "string"
assert data.movie.inCinemas == date(2000, 4, 25)
assert data.movie.physicalRelease == date(2000, 7, 8)
assert data.movie.digitalRelease == date(2000, 2, 1)
assert data.movie.releaseDateType() == (date(2000, 7, 8), "physicalRelease")
assert data.movie.inCinemas == datetime(2000, 4, 25, tzinfo=UTC)
assert data.movie.physicalRelease == datetime(2000, 7, 8, tzinfo=UTC)
assert data.movie.digitalRelease == datetime(2000, 2, 1, tzinfo=UTC)
assert data.movie.releaseDateType() == (
datetime(2000, 7, 8, tzinfo=UTC),
"physicalRelease",
)
assert data.movie.images[0].coverType == ImageType.POSTER.value
assert data.movie.images[0].url == "string"
assert data.movie.website == "string"
Expand All @@ -1230,7 +1243,7 @@ async def test_async_parse(aresponses: Server, radarr_client: RadarrClient) -> N
assert data.movie.certification == "string"
assert data.movie.genres == ["string"]
assert isinstance(data.movie.tags[0], int)
assert data.movie.added == datetime(2020, 11, 28, 6, 34, 25)
assert data.movie.added == datetime(2020, 11, 28, 6, 34, 25, tzinfo=UTC)
assert isinstance(data.movie.ratings.imdb.votes, int)
assert isinstance(data.movie.ratings.imdb.value, float)
assert data.movie.ratings.imdb.type == "string"
Expand All @@ -1247,7 +1260,9 @@ async def test_async_parse(aresponses: Server, radarr_client: RadarrClient) -> N
assert data.movie.movieFile.relativePath == "string"
assert data.movie.movieFile.path == "string"
assert isinstance(data.movie.movieFile.size, int)
assert data.movie.movieFile.dateAdded == datetime(2020, 2, 23, 12, 0, 46)
assert data.movie.movieFile.dateAdded == datetime(
2020, 2, 23, 12, 0, 46, tzinfo=UTC
)
assert isinstance(data.movie.movieFile.indexerFlags, int)
assert isinstance(data.movie.movieFile.quality.quality.id, int)
assert data.movie.movieFile.quality.quality.name == "string"
Expand Down Expand Up @@ -1339,7 +1354,7 @@ async def test_async_get_release(
assert isinstance(data[0].imdbId, int)
assert data[0].rejections[0].reason == "string"
assert data[0].rejections[0].type == "permanent"
assert data[0].publishDate == datetime(2022, 1, 7, 4, 20, 36)
assert data[0].publishDate == datetime(2022, 1, 7, 4, 20, 36, tzinfo=UTC)
assert data[0].commentUrl == "string"
assert data[0].downloadUrl == "string"
assert data[0].infoUrl == "string"
Expand Down Expand Up @@ -1435,7 +1450,7 @@ async def test_async_get_manual_import(
assert isinstance(data[0].movie.sizeOnDisk, int)
assert data[0].movie.status == "released"
assert data[0].movie.overview == "string"
assert data[0].movie.inCinemas == date(2010, 5, 20)
assert data[0].movie.inCinemas == datetime(2010, 5, 20, tzinfo=UTC)
assert data[0].movie.images[0].coverType == "string"
assert data[0].movie.images[0].url == "string"
assert data[0].movie.website == "string"
Expand All @@ -1457,7 +1472,7 @@ async def test_async_get_manual_import(
assert data[0].movie.certification == "string"
assert data[0].movie.genres == ["string"]
assert isinstance(data[0].movie.tags[0], int)
assert data[0].movie.added == datetime(2019, 5, 31, 5, 1, 52)
assert data[0].movie.added == datetime(2019, 5, 31, 5, 1, 52, tzinfo=UTC)
assert isinstance(data[0].movie.ratings.imdb.votes, int)
assert isinstance(data[0].movie.ratings.imdb.value, int)
assert data[0].movie.ratings.imdb.type == "user"
Expand Down Expand Up @@ -2028,8 +2043,3 @@ async def test_not_implemented(radarr_client: RadarrClient) -> None:

with pytest.raises(NotImplementedError):
await radarr_client.async_delete_metadata_profile(0)


def test_get_date_returns() -> None:
"""Test get date function returns with no date."""
assert get_date(True) is None
Loading