Skip to content

Commit

Permalink
Use NamedTuple typing
Browse files Browse the repository at this point in the history
  • Loading branch information
glensc committed Apr 18, 2023
1 parent fa4abe8 commit 8b5ca32
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 23 deletions.
36 changes: 29 additions & 7 deletions trakt/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
import os
import sys
import time
from collections import namedtuple
from datetime import datetime, timedelta, timezone
from functools import wraps
from json import JSONDecodeError
from typing import NamedTuple
from urllib.parse import urljoin

import requests
Expand Down Expand Up @@ -362,12 +362,34 @@ def init(*args, **kwargs):
return auth_method.get(AUTH_METHOD, PIN_AUTH)(*args, **kwargs)


Airs = namedtuple('Airs', ['day', 'time', 'timezone'])
Alias = namedtuple('Alias', ['title', 'country'])
Genre = namedtuple('Genre', ['name', 'slug'])
Comment = namedtuple('Comment', ['id', 'parent_id', 'created_at', 'comment',
'spoiler', 'review', 'replies', 'user',
'updated_at', 'likes', 'user_rating'])
class Airs(NamedTuple):
day: str
time: str
timezone: str


class Alias(NamedTuple):
title: str
country: str


class Genre(NamedTuple):
name: str
slug: str


class Comment(NamedTuple):
id: str
parent_id: str
created_at: str
comment: str
spoiler: str
review: str
replies: str
user: str
updated_at: str
likes: str
user_rating: str


def _validate_token(s):
Expand Down
19 changes: 14 additions & 5 deletions trakt/movies.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
"""Interfaces to all of the Movie objects offered by the Trakt.tv API"""
from collections import namedtuple
from typing import NamedTuple

from trakt.core import Alias, Comment, Genre, delete, get
from trakt.mixins import IdsMixin
Expand All @@ -16,8 +16,13 @@
'trending_movies', 'updated_movies', 'Release', 'Movie',
'Translation']

Translation = namedtuple('Translation', ['title', 'overview', 'tagline',
'language'])

# FIXME: same symbol in tv module
class Translation(NamedTuple):
title: str
overview: str
tagline: str
language: str


@delete
Expand Down Expand Up @@ -76,8 +81,12 @@ def updated_movies(timestamp=None):
yield to_ret


Release = namedtuple('Release', ['country', 'certification', 'release_date',
'note', 'release_type'])
class Release(NamedTuple):
country: str
certification: str
release_date: str
note: str
release_type: str


class Movie(IdsMixin):
Expand Down
8 changes: 6 additions & 2 deletions trakt/tv.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""Interfaces to all of the TV objects offered by the Trakt.tv API"""
from collections import namedtuple
from datetime import datetime, timedelta
from typing import NamedTuple
from urllib.parse import urlencode

from trakt.core import Airs, Alias, Comment, Genre, delete, get
Expand All @@ -22,7 +22,11 @@
'TVSeason', 'Translation']


Translation = namedtuple('Translation', ['title', 'overview', 'language'])
# FIXME: same symbol in movie module
class Translation(NamedTuple):
title: str
overview: str
language: str


@delete
Expand Down
28 changes: 19 additions & 9 deletions trakt/users.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# -*- coding: utf-8 -*-
"""Interfaces to all of the User objects offered by the Trakt.tv API"""
from collections import namedtuple
from typing import NamedTuple

from trakt.core import delete, get, post
from trakt.mixins import IdsMixin
Expand All @@ -14,8 +15,10 @@
'get_user_settings', 'unfollow']


class Request(namedtuple('Request', ['id', 'requested_at', 'user'])):
__slots__ = ()
class Request(NamedTuple):
id: int
user: str
requested_at: str

@post
def approve(self):
Expand Down Expand Up @@ -62,13 +65,20 @@ def unfollow(user_name):
yield 'users/{username}/follow'.format(username=slugify(user_name))


class UserList(namedtuple('UserList', ['name', 'description', 'privacy',
'share_link', 'type', 'display_numbers',
'allow_comments', 'sort_by',
'sort_how', 'created_at',
'updated_at', 'item_count',
'comment_count', 'likes', 'ids',
'user', 'creator']), IdsMixin):
UserListFields = [
'name', 'description', 'privacy',
'share_link', 'type', 'display_numbers',
'allow_comments', 'sort_by',
'sort_how', 'created_at',
'updated_at', 'item_count',
'comment_count', 'likes', 'ids',
'user', 'creator',
]
# Can't have NamedTuple and __init__, so this stays as namedtuple()
UserListTuple = namedtuple('UserList', UserListFields)


class UserList(UserListTuple, IdsMixin):
"""A list created by a Trakt.tv :class:`User`"""

def __init__(self, *args, ids=None, **kwargs):
Expand Down

0 comments on commit 8b5ca32

Please sign in to comment.