Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Google Client API v3 - update a file on drive using Python

I'm trying to update the content of a file from a python script using the google client api. The problem is that I keep receiving error 403:

An error occurred: <HttpError 403 when requesting https://www.googleapis.com /upload/drive/v3/files/...?alt=json&uploadType=resumable returned "The resource body includes fields which are not directly writable.

I have tried to remove metadata fields, but didn't help.

The function to update the file is the following:

# File: utilities.py
from googleapiclient import errors
from googleapiclient.http import MediaFileUpload
from googleapiclient.discovery import build
from httplib2 import Http
from oauth2client import file, client, tools

def update_file(service, file_id, new_name, new_description, new_mime_type,
            new_filename):
"""Update an existing file's metadata and content.

Args:
    service: Drive API service instance.
    file_id: ID of the file to update.
    new_name: New name for the file.
    new_description: New description for the file.
    new_mime_type: New MIME type for the file.
    new_filename: Filename of the new content to upload.
    new_revision: Whether or not to create a new revision for this file.
Returns:
    Updated file metadata if successful, None otherwise.
"""
    try:
        # First retrieve the file from the API.
        file = service.files().get(fileId=file_id).execute()

        # File's new metadata.
        file['name'] = new_name
        file['description'] = new_description
        file['mimeType'] = new_mime_type
        file['trashed'] = True

        # File's new content.
        media_body = MediaFileUpload(
            new_filename, mimetype=new_mime_type, resumable=True)

        # Send the request to the API.
        updated_file = service.files().update(
            fileId=file_id,
            body=file,
            media_body=media_body).execute()
        return updated_file
    except errors.HttpError as error:
        print('An error occurred: %s' % error)
        return None

And here there is the whole script to reproduce the problem. The goal is to substitute a file, retrieving its id by name. If the file does not exist yet, the script will create it by calling insert_file (this function works as expected). The problem is update_file, posted above.

from __future__ import print_function
from utilities import *
from googleapiclient import errors
from googleapiclient.http import MediaFileUpload
from googleapiclient.discovery import build
from httplib2 import Http
from oauth2client import file, client, tools

def get_authenticated(SCOPES, credential_file='credentials.json',
                  token_file='token.json', service_name='drive',
                  api_version='v3'):
    # The file token.json stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    store = file.Storage(token_file)
    creds = store.get()
    if not creds or creds.invalid:
        flow = client.flow_from_clientsecrets(credential_file, SCOPES)
        creds = tools.run_flow(flow, store)
    service = build(service_name, api_version, http=creds.authorize(Http()))
    return service


def retrieve_all_files(service):
    """Retrieve a list of File resources.

    Args:
        service: Drive API service instance.
    Returns:
        List of File resources.
    """

    result = []
    page_token = None
    while True:
        try:
            param = {}
            if page_token:
                param['pageToken'] = page_token
            files = service.files().list(**param).execute()

            result.extend(files['files'])
            page_token = files.get('nextPageToken')
            if not page_token:
                break
        except errors.HttpError as error:
            print('An error occurred: %s' % error)
            break

    return result


def insert_file(service, name, description, parent_id, mime_type, filename):
    """Insert new file.

    Args:
        service: Drive API service instance.
        name: Name of the file to insert, including the extension.
        description: Description of the file to insert.
        parent_id: Parent folder's ID.
        mime_type: MIME type of the file to insert.
        filename: Filename of the file to insert.
    Returns:
        Inserted file metadata if successful, None otherwise.
    """
    media_body = MediaFileUpload(filename, mimetype=mime_type, resumable=True)
    body = {
        'name': name,
        'description': description,
        'mimeType': mime_type
    }
    # Set the parent folder.
    if parent_id:
        body['parents'] = [{'id': parent_id}]

    try:
        file = service.files().create(
            body=body,
            media_body=media_body).execute()

        # Uncomment the following line to print the File ID
        # print 'File ID: %s' % file['id']

        return file
    except errors.HttpError as error:
        print('An error occurred: %s' % error)
        return None


# If modifying these scopes, delete the file token.json.
SCOPES = 'https://www.googleapis.com/auth/drive'

def main():
    service = get_authenticated(SCOPES)

    # Call the Drive v3 API
    results = retrieve_all_files(service)

    target_file_descr = 'Description of deploy.py'
    target_file = 'deploy.py'
    target_file_name = target_file
    target_file_id = [file['id'] for file in results if file['name'] == target_file_name]

    if len(target_file_id) == 0:
        print('No file called %s found in root. Create it:' % target_file_name)
        file_uploaded = insert_file(service, target_file_name, target_file_descr, None,
                                'text/x-script.phyton', target_file_name)
    else:
        print('File called %s found. Update it:' % target_file_name)
        file_uploaded = update_file(service, target_file_id[0], target_file_name, target_file_descr,
                                'text/x-script.phyton', target_file_name)

    print(str(file_uploaded))


if __name__ == '__main__':
    main()

In order to try the example, is necessary to create a Google Drive API from https://console.developers.google.com/apis/dashboard, then save the file credentials.js and pass its path to get_authenticated(). The file token.json will be created after the first authentication and API authorization.

like image 935
Andrea Avatar asked Mar 05 '23 20:03

Andrea


1 Answers

The problem is that the metadata 'id' can not be changed when updating a file, so it should not be in the body. Just delete it from the dict:

# File's new metadata.
del file['id']  # 'id' has to be deleted
file['name'] = new_name
file['description'] = new_description
file['mimeType'] = new_mime_type
file['trashed'] = True

I tried your code with this modification and it works

like image 84
churruscat Avatar answered Mar 10 '23 11:03

churruscat