From d0f38ca53212f6d770d30922364a31ba75ff75bd Mon Sep 17 00:00:00 2001 From: mrhanky Date: Thu, 1 Jun 2017 14:50:35 +0200 Subject: [PATCH] Added some docs to jewtube plugin --- nxy/plugins/youtube.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/nxy/plugins/youtube.py b/nxy/plugins/youtube.py index b982e6d..f742be7 100644 --- a/nxy/plugins/youtube.py +++ b/nxy/plugins/youtube.py @@ -5,12 +5,11 @@ import re import requests from docopt import Dict as DocOptDict -from irc3 import event, IrcBot from irc3.plugins.command import command from irc3.utils import IrcString from . import Plugin -from ..utils import date_from_iso, pp +from ..utils import date_from_iso # TODO: write better code lol @@ -23,6 +22,7 @@ class YouTube(Plugin): SEARCH = '{}/search?part=id'.format(URL) def get_video_data(self, video_id: str): + """Requests the infos for a video id and formats them.""" data = self._api(self.API, id=video_id) if not data['items']: @@ -53,8 +53,8 @@ class YouTube(Plugin): views=views, date=date.strftime('%Y.%m.%d')) - @event(r'(?i)^:.* PRIVMSG (?P.*) :.*(?:youtube.*?(?:v=|/v/)' - r'|youtu\.be/)(?P[-_a-zA-Z0-9]+).*') + @irc3.event(r'(?i)^:.* PRIVMSG (?P.*) :.*(?:youtube.*?(?:v=|/v/)' + r'|youtu\.be/)(?P[-_a-zA-Z0-9]+).*') def youtube_parser(self, target: str, video_id: str): data = self.get_video_data(video_id) if data: @@ -81,5 +81,6 @@ class YouTube(Plugin): @staticmethod def _api(url: str, **kwargs): + """Wrapper around requests.get which adds the Google API key.""" kwargs['key'] = os.environ['GOOGLE_API_KEY'] return requests.get(url, params=kwargs).json()