update-metadata

#!/usr/bin/env python3

import re

import auth
from common import logger


# https://developers.google.com/resources/api-libraries/documentation/youtube/v3/python/latest/youtube_v3.videos.html#list
def fetch_video_metadata(youtube_client, video_id):
    list_request = youtube_client.videos().list(
        part='snippet',
        id=video_id,
    )
    list_response = list_request.execute()
    items = list_response['items']
    if not items:
        raise ValueError('video_id does not exist')
    else:
        return items[0]


# https://developers.google.com/resources/api-libraries/documentation/youtube/v3/python/latest/youtube_v3.videos.html#update
def update_title(youtube_client, video_id, pattern, repl, *, dry_run=False):
    metadata = fetch_video_metadata(youtube_client, video_id)
    snippet = metadata['snippet']
    if pattern:
        title = snippet['title']
        m = re.match(pattern, title)
        if m:
            # Make sure the entire title is matched in order to prevent accidental loss of info.
            if not m.group(0) == title:
                logger.warning(f'{video_id} title only partially matches {pattern}: {title}')
                return
            new_title = m.expand(repl)
        else:
            logger.warning(f'{video_id} title unchanged: {title}')
            return
    else:
        # Replace title with repl, verbatim, without consulting the existing title
        new_title = repl

    if not dry_run:
        snippet['title'] = new_title
        update_request = youtube_client.videos().update(
            part='id,snippet',
            body=dict(
                id=video_id,
                snippet=snippet,
            ),
        )
        update_request.execute()
    logger.info(f'{video_id} title updated: {new_title}')


# https://developers.google.com/resources/api-libraries/documentation/youtube/v3/python/latest/youtube_v3.videos.html#update
def update_description(youtube_client, video_id, description):
    metadata = fetch_video_metadata(youtube_client, video_id)
    snippet = metadata['snippet']
    snippet['description'] = description

    update_request = youtube_client.videos().update(
        part='id,snippet',
        body=dict(
            id=video_id,
            snippet=snippet,
        ),
    )
    update_request.execute()
    logger.info(f'{video_id} description updated')


# https://developers.google.com/resources/api-libraries/documentation/youtube/v3/python/latest/youtube_v3.videos.html#update
def tag(youtube_client, video_id, tags, *, overwrite=False):
    metadata = fetch_video_metadata(youtube_client, video_id)
    snippet = metadata['snippet']
    if overwrite:
        snippet['tags'] = tags
    else:
        for tag_ in tags:
            if tag_ not in snippet['tags']:
                snippet['tags'].append(tag_)

    update_request = youtube_client.videos().update(
        part='id,snippet',
        body=dict(
            id=video_id,
            snippet=snippet,
        ),
    )
    update_request.execute()
    logger.info(f'{video_id} tags updated: {",".join(snippet["tags"])}')


# https://developers.google.com/resources/api-libraries/documentation/youtube/v3/python/latest/youtube_v3.videos.html#update
def publish(youtube_client, video_id):
    update_request = youtube_client.videos().update(
        part='id,status',
        body=dict(
            id=video_id,
            status=dict(
                privacyStatus='public',
            ),
        ),
    )
    update_request.execute()
    logger.info(f'{video_id} published')


# https://developers.google.com/resources/api-libraries/documentation/youtube/v3/python/latest/youtube_v3.playlists.html#list
def playlist_length(youtube_client, playlist_id):
    list_request = youtube_client.playlists().list(
        part='contentDetails',
        id=playlist_id,
    )
    list_response = list_request.execute()
    items = list_response['items']
    if not items:
        raise ValueError('video_id does not exist')
    else:
        return items[0]['contentDetails']['itemCount']


# A negative position is counted from the end of the playlist; e.g., -1
# is means the video is to be inserted at the bottom.
#
# https://developers.google.com/resources/api-libraries/documentation/youtube/v3/python/latest/youtube_v3.playlistItems.html#insert
def insert_playlist(youtube_client, video_id, playlist_id, *, position=0):
    if position < 0:
        length = playlist_length(youtube_client, playlist_id)
        position += length + 1

    insert_request = youtube_client.playlistItems().insert(
        part='snippet',
        body=dict(
            snippet=dict(
                playlistId=playlist_id,
                resourceId=dict(
                    kind='youtube#video',
                    videoId=video_id,
                ),
                position=position,
            ),
        ),
    )
    insert_request.execute()
    logger.info(f'{video_id} inserted into playlist {playlist_id}')


def update_title_handler(args):
    for video_id in args.video_ids.split(','):
        update_title(args.youtube_client, video_id, args.pattern, args.repl, dry_run=args.test)


def update_description_handler(args):
    for video_id in args.video_ids.split(','):
        update_description(args.youtube_client, video_id, args.description)


def tag_handler(args):
    for video_id in args.video_ids.split(','):
        tag(args.youtube_client, video_id, args.tags.split(','), overwrite=args.overwrite)


def publish_handler(args):
    for video_id in args.video_ids.split(','):
        publish(args.youtube_client, video_id)


def insert_playlist_handler(args):
    for video_id in args.video_ids.split(','):
        for playlist_id in args.playlist_ids.split(','):
            insert_playlist(args.youtube_client, video_id, playlist_id,
                            position=-1 if args.bottom else 0)


def main():
    parser = auth.ArgumentParser()
    subparsers = parser.add_subparsers()

    desc = '''If pattern is nonempty, the title is replaced with
    re.search(pattern, current_title).expand(repl); otherwise, the title
    is directly replaced with repl.'''
    parser_update_title = subparsers.add_parser('update-title', description=desc)
    add = parser_update_title.add_argument
    add('-t', '--test', action='store_true',
        help='show expected renames but do not commit to them')
    add('video_ids', help='comma-delimited video IDs')
    add('pattern')
    add('repl')
    parser_update_title.set_defaults(handler=update_title_handler)

    parser_update_description = subparsers.add_parser('update-description')
    add = parser_update_description.add_argument
    add('video_ids', help='comma-delimited video IDs')
    add('description')
    parser_update_description.set_defaults(handler=update_description_handler)

    parser_tag = subparsers.add_parser('tag')
    add = parser_tag.add_argument
    add('-o', '--overwrite', action='store_true', help='overwrite existing tags')
    add('video_ids', help='comma-delimited video IDs')
    add('tags', help='comma-delimited new tags')
    parser_tag.set_defaults(handler=tag_handler)

    parser_publish = subparsers.add_parser('publish')
    add = parser_publish.add_argument
    add('video_ids', help='comma-delimited video IDs')
    parser_publish.set_defaults(handler=publish_handler)

    parser_insert_playlist = subparsers.add_parser('insert-playlist')
    add = parser_insert_playlist.add_argument
    add('-b', '--bottom', action='store_true',
        help='insert to the bottom of the playlist(s) instead of top')
    add('video_ids', help='comma-delimited video IDs')
    add('playlist_ids', help='comma-delimited playlist IDs')
    parser_insert_playlist.set_defaults(handler=insert_playlist_handler)

    args = parser.parse_args()
    args.youtube_client = auth.get_youtube_client(args, 'youtube')
    args.handler(args)


if __name__ == '__main__':
    main()