Kii@SrSSKJr SSKJr SSKJrJrJrJrJ r J r SSK J r SSK JrJr SSKJrJr SS KJrJrJr SS KJr SS KJrJr SS KJrJrJrJ r "S S5r!g)zn gspread.client ~~~~~~~~~~~~~~ This module contains Client class responsible for managing spreadsheet files )datetime) HTTPStatus)AnyDictListOptionalTupleUnion) Credentials)ResponseSession)APIErrorSpreadsheetNotFound) HTTPClientHTTPClientType ParamsType) Spreadsheet)DRIVE_FILES_API_V3_COMMENTS_URLDRIVE_FILES_API_V3_URL) ExportFormatMimeTypeextract_id_from_urlfinditemc\rSrSrSrS\4S\S\\S\ SS4Sjjr \ S\\ 4S j5r S-S \\\\\\44SS4S jjrS \S\4S jrS.S\\S\\S\\\\44SjjrS.S\\S\\S\\\\\4\44SjjrS-S\S\\S\4SjjrS\S\4SjrS\S\4SjrS-S\\S\\4SjjrS-S\S\\S\4Sjjr\ RB4S\S\S\"4Sjjr#S/S\S\\S\$S\\S\$S\4 Sjjr%S\SS4Sjr&S\S \\\"4S\4S!jr'S\S\\\\\\$444S"jr(S0S\S#\\S$\\S%\\S&\$S'\\S(\$S\4S)jjr)S\S*\SS4S+jr*S,r+g)1ClientaAn instance of this class Manages Spreadsheet files It is used to: - open/create/list/delete spreadsheets - create/delete/list spreadsheet permission - etc It is the gspread entry point. It will handle creating necessary :class:`~gspread.models.Spreadsheet` instances. Nauthsession http_clientreturncU"X5UlgNr )selfrrr s aC:\Users\julio\OneDrive\Documentos\Trabajo\Ideas Frescas\venv\Lib\site-packages\gspread/client.py__init__Client.__init__#s 't5cBURRR$)zReturns the expiry date of the curenlty loaded credentials :returns: (optional) datetime the expiry date time object. .. note:: It only applies to gspread client created using oauth )r rexpiry)r%s r&r+ Client.expiry+s$$+++r)timeoutc:URRU5 g)zHow long to wait for the server to send data before giving up, as a float, or a ``(connect timeout, read timeout)`` tuple. Use value ``None`` to restore default timeout Value for ``timeout`` is in seconds (s). N)r set_timeout)r%r-s r&r/Client.set_timeout7s $$W-r)idc8URRU5$)zGet the metadata from the Drive API for a specific file This method is mainly here to retrieve the create/update time of a file (these metadata are only accessible from the Drive API). )r get_file_drive_metadata)r%r1s r&r3Client.get_file_drive_metadataDs 77;;r)title folder_idc(URXS9up4U$)aList all the spreadsheet files Will list all spreadsheet files owned by/shared with this user account. :param str title: Filter only spreadsheet files with this title :param str folder_id: Only look for spreadsheet files in this folder The parameter ``folder_id`` can be obtained from the URL when looking at a folder in a web browser as follow: ``https://drive.google.com/drive/u/0/folders/`` :returns: a list of dicts containing the keys id, name, createdTime and modifiedTime. )r5r6)_list_spreadsheet_files)r%r5r6files_s r&list_spreadsheet_filesClient.list_spreadsheet_filesKs//e/Q r)cX/nSn[nS[RS3nU(a USUS3- nU(a USUS3- nUSSSSS .nU(aXGS 'URR S XWS 9nUR 5n UR U S 5 U RSS5nUcX84$Md)Nz mimeType=""z and name = "z and parents in "iTz:kind,nextPageToken,files(id,name,createdTime,modifiedTime))qpageSizesupportsAllDrivesincludeItemsFromAllDrivesfields pageTokengetparamsr9 nextPageToken)rr google_sheetsr requestjsonextendrF) r%r5r6r9 page_tokenurlqueryrHresponse response_jsons r&r8Client._list_spreadsheet_files]s $X334A6  }UG1- -E  ( 15 5E!%)-R  &0{#''//s/JH$MMOM LLw/ 0&**?DAJ!r)c^URTU5up4[U4SjU5nUSUS'[ UR U5$![an[U5UeSnAff=f)aOpens a spreadsheet. :param str title: A title of a spreadsheet. :param str folder_id: (optional) If specified can be used to filter spreadsheets by parent folder ID. :returns: a :class:`~gspread.models.Spreadsheet` instance. If there's more than one spreadsheet with same title the first one will be opened. :raises gspread.SpreadsheetNotFound: if no spreadsheet with specified `title` is found. >>> gc.open('My fancy spreadsheet') c>UST:H$)Nname)xr5s r&Client.open..s!F)u,r)NrVr5)r8r StopIterationrrr )r%r5r6spreadsheet_filesrQ propertiesexs ` r&open Client.openss '+&B&B5)&T# 8!,!J)0 74++Z88  8%h/R 7 8sA A  AA keyc:[URSU05nU$![atnURR[ R :Xa[UR5UeURR[ R:Xa[UeUeSnAff=f)a Opens a spreadsheet specified by `key` (a.k.a Spreadsheet ID). :param str key: A key of a spreadsheet as it appears in a URL in a browser. :returns: a :class:`~gspread.models.Spreadsheet` instance. >>> gc.open_by_key('0BmgG6nO_6dprdS1MN3d3MkdPa142WFRrdnRRUWl1UFE') r1N) rr rrQ status_coder NOT_FOUNDr FORBIDDENPermissionError)r%ra spreadsheetr^s r& open_by_keyClient.open_by_keys %d&6&6s DK  {{&&**>*>>)"++6B>{{&&**>*>>%2-H  s BA/BBrOc6UR[U55$)aqOpens a spreadsheet specified by `url`. :param str url: URL of a spreadsheet as it appears in a browser. :returns: a :class:`~gspread.models.Spreadsheet` instance. :raises gspread.SpreadsheetNotFound: if no spreadsheet with specified `url` is found. >>> gc.open_by_url('https://docs.google.com/spreadsheet/ccc?key=0Bm...FE&hl') )rhr)r%rOs r& open_by_urlClient.open_by_urls 3C 899r)c URU5nU(aUVs/sHo1US:XdM UPM nnUVs/sH'n[UR[SSUS0UD65PM) sn$s snfs snf)zOpens all available spreadsheets. :param str title: (optional) If specified can be used to filter spreadsheets by title. :returns: a list of :class:`~gspread.models.Spreadsheet` instances. rVr5rW)r;rr dict)r%r5r\spreadrXs r&openallClient.openalls!77> %6!%666&>:Q%6 ! ' & (($*DQvY*D!*D E&  ! s A*A*.A/cU[RS.nSS0nUbU/US'URRS[X4S9nUR 5SnUR U5$)zCreates a new spreadsheet. :param str title: A title of a new spreadsheet. :param str folder_id: Id of the folder where we want to save the spreadsheet. :returns: a :class:`~gspread.models.Spreadsheet` instance. rVmimeTyperBTparentspostrLrHr1)rrJr rKrrLrh)r%r5r6payloadrHrspreadsheet_ids r&create Client.creates~ ..#     "+GI     $ $ * % $//r)file_idformatc4URRXS9$)aoExport the spreadsheet in the given format. :param str file_id: The key of the spreadsheet to export :param str format: The format of the resulting file. Possible values are: * ``ExportFormat.PDF`` * ``ExportFormat.EXCEL`` * ``ExportFormat.CSV`` * ``ExportFormat.OPEN_OFFICE_SHEET`` * ``ExportFormat.TSV`` * ``ExportFormat.ZIPPED_HTML`` See `ExportFormat`_ in the Drive API. :type format: :class:`~gspread.utils.ExportFormat` :returns bytes: The content of the exported file. .. _ExportFormat: https://developers.google.com/drive/api/guides/ref-export-formats )r}r~)r export)r%r}r~s r&r Client.exports0&&w&FFr)copy_permissions copy_commentsc SR[U5nU[RS.nUbU/US'SS0nURR SXgUS9n U R 5S n URU 5n USLaURU5n U R5n U HnURS 5(aMS n[US 5S :Xa[US 5nO [US 5S;a[US5nU RU[US 5[US5SS9 M USLa[U-nS n/nSSSS.nUbYUUS'URR SUUS9R 5nURUS5 URSS5nUbMY[U R-nSS 0nUHnURR SUUUS9 M! U $)aCopies a spreadsheet. :param str file_id: A key of a spreadsheet to copy. :param str title: (optional) A title for the new spreadsheet. :param bool copy_permissions: (optional) If True, copy permissions from the original spreadsheet to the new spreadsheet. :param str folder_id: Id of the folder where we want to save the spreadsheet. :param bool copy_comments: (optional) If True, copy the comments from the original spreadsheet to the new spreadsheet. :returns: a :class:`~gspread.models.Spreadsheet` instance. .. versionadded:: 3.1.0 .. note:: If you're using custom credentials without the Drive scope, you need to add ``https://www.googleapis.com/auth/drive`` to your OAuth scope in order to use this method. Example:: scope = [ 'https://www.googleapis.com/auth/spreadsheets', 'https://www.googleapis.com/auth/drive' ] Otherwise, you will get an ``Insufficient Permission`` error when you try to copy a spreadsheet. z {}/{}/copyrsNrurBTrvrwr1deletedr>typedomain)usergroup emailAddressroleF) email_address perm_typernotifyz.comments/content,comments/anchor,nextPageTokend)rDincludeDeletedrArErFrGcommentsrIrD)r~rrrJr rKrLrhlist_permissionsrFstrsharerrMr1)r%r}r5rr6rrOrxrHryrznew_spreadsheetoriginal permissionspemail_or_domain source_urlrNrresdestination_urlcomments r&copy Client.copy sV!!"8'B ..#   "+GI 148    $ $VSv $ N$**>: t #''0H"335K 55## #%qy>X-&)!H+&6O6^'88&)!N*;&ASASTO%F#  ((O'&)$ r)clSR[U5nSS0nURRSX#S9 g)zNDeletes a spreadsheet. :param str file_id: a spreadsheet ID (a.k.a file ID). z{}/{}rBTdeleterGN)r~rr rK)r%r}rOrHs r&del_spreadsheetClient.del_spreadsheetzs8 nn3W=148   3 >r)datac8URRX5$)aImports data into the first page of the spreadsheet. :param str file_id: :param str data: A CSV string of data. Example: .. code:: # Read CSV file contents content = open('file_to_import.csv', 'r').read() gc.import_csv(spreadsheet.id, content) .. note:: This method removes all other worksheets and then entirely replaces the contents of the first worksheet. )r import_csv)r%r}rs r&rClient.import_csvs***799r)c8URRU5$)z`Retrieve a list of permissions for a file. :param str file_id: a spreadsheet ID (aka file ID). )r r)r%r}s r&rClient.list_permissionss 0099r)valuerrr email_message with_linkc >URRXX4XVU5$)axCreates a new permission for a file. :param str file_id: a spreadsheet ID (aka file ID). :param value: user or group e-mail address, domain name or None for 'anyone' type. :type value: str, None :param str perm_type: (optional) The account type. Allowed values are: ``user``, ``group``, ``domain``, ``anyone`` :param str role: (optional) The primary role for this user. Allowed values are: ``owner``, ``writer``, ``reader`` :param bool notify: (optional) Whether to send an email to the target user/domain. :param str email_message: (optional) An email message to be sent if ``notify=True``. :param bool with_link: (optional) Whether the link is required for this permission to be active. :returns dict: the newly created permission Examples:: # Give write permissions to otto@example.com gc.insert_permission( '0BmgG6nO_6dprnRRUWl1UFE', 'otto@example.org', perm_type='user', role='writer' ) # Make the spreadsheet publicly readable gc.insert_permission( '0BmgG6nO_6dprnRRUWl1UFE', None, perm_type='anyone', role='reader' ) )r insert_permission)r%r}rrrrrrs r&rClient.insert_permissions'd11 IVI  r) permission_idc:URRX5 g)zDeletes a permission from a file. :param str file_id: a spreadsheet ID (aka file ID.) :param str permission_id: an ID for the permission. N)r remove_permission)r%r}rs r&rClient.remove_permissions **7Br)r$r#)NN)NFNT)NNNTNF),__name__ __module__ __qualname____firstlineno____doc__rr rr rr'propertyrr+r floatr r/rrr3rrr;r r8rr_rhrkrpr{rPDFbytesrboolrrrrrr__static_attributes__rWr)r&rrs &*&0 66'"6$ 6  6 ,* , ,FJ .eU5%<-@&@ AB .  .<#<#<GKc]6>sm d38n &GK"c]"6>sm" tDcN#X- ."H9#9(3-9;9<s{$ :s :{ : Xc] d;6G (0C0HSM0[0:2>1A1AGcG3GeG: $!&#'" nn}n n C= n  n n`?s?t?:#:U3:->:3:.::T#uS$Y?O:O5P0Q: $#'"'+4 4 }4 C= 4 sm 4  4  }4 4  4 lCCSCTCr)rN)"rrhttprtypingrrrrr r google.auth.credentialsr requestsr r exceptionsrrr rrrrgrurlsrrutilsrrrrrrWr)r&rsA::/&5??$IHHGCGCr)