leaf_engine.io.gdrive.service

Attributes

GOOGLE_DRIVE_SCOPES

LeafGoogleDriveException

MIME_TYPE_CSV

MIME_TYPE_EXCEL_SPREADSHEET

MIME_TYPE_FOLDER

Functions

create(→ dict)

Executes Google Drive HttpRequest to create/upload resources (files,

get_credentials(→ dict)

get_service()

update(→ dict)

Executes Google Drive HttpRequest to update files.

Module Contents

leaf_engine.io.gdrive.service.create(name: str, parent_folder_id: str | None, drive_id: str, mime_type: str | None = None, media: googleapiclient.http.MediaFileUpload | googleapiclient.http.MediaIoBaseUpload | None = None) dict

Executes Google Drive HttpRequest to create/upload resources (files, folders).

Parameters:
  • name (str) – Resource name.

  • parent_folder_id (str) – Google Drive folder ID where to place resource. The ID can be found in the folder URL. If None, creates resource in Drive root.

  • drive_id (str, optional) – The Google Drive ID to upload to.

  • mime_type (Optional[str], optional) – Type of resource to create.

  • media (Optional[Union[MediaFileUpload, MediaIoBaseUpload]], optional) – When creating/uploading files, the file content.

Returns:

Request response.

Return type:

dict

leaf_engine.io.gdrive.service.get_credentials() dict
Return type:

dict

leaf_engine.io.gdrive.service.get_service()
leaf_engine.io.gdrive.service.update(file_id: str, media: googleapiclient.http.MediaFileUpload | googleapiclient.http.MediaIoBaseUpload) dict

Executes Google Drive HttpRequest to update files.

Parameters:
  • file_id (str) – File ID.

  • media (Union[MediaFileUpload, MediaIoBaseUpload]]) – File content.

Returns:

Request response.

Return type:

dict

leaf_engine.io.gdrive.service.GOOGLE_DRIVE_SCOPES = ['https://www.googleapis.com/auth/drive']
leaf_engine.io.gdrive.service.LeafGoogleDriveException
leaf_engine.io.gdrive.service.MIME_TYPE_CSV = 'text/csv'
leaf_engine.io.gdrive.service.MIME_TYPE_EXCEL_SPREADSHEET = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
leaf_engine.io.gdrive.service.MIME_TYPE_FOLDER = 'application/vnd.google-apps.folder'