Yia=SrSSKJr SSKJrJrJrJrJrJ r SSK J r SSK J r Jr SSKJrJr SSKJrJrJr SS KJr SS KJrJrJr SS KJrJrJrJ r "S S 5r!g)zn gspread.client ~~~~~~~~~~~~~~ This module contains Client class responsible for managing spreadsheet files ) HTTPStatus)AnyDictListOptionalTupleUnion) Credentials)ResponseSession)APIErrorSpreadsheetNotFound) HTTPClientHTTPClientType ParamsType) Spreadsheet)DRIVE_FILES_API_V3_COMMENTS_URLDRIVE_FILES_API_V3_URLDRIVE_FILES_UPLOAD_API_V2_URL) ExportFormatMimeTypeextract_id_from_urlfinditemcn\rSrSrSrS\4S\S\\S\ SS4Sjjr S \ S\ 4S jr S*S \\ S \\ S\\\ \ 44S jjrS*S\\\\ \ 4\44SjjrS+S \ S \\ S\4SjjrS\ S\4SjrS\ S\4SjrS+S \\ S\\4SjjrS+S \ S \\ S\4Sjjr\R64S\ S\ S\4SjjrS,S\ S \\ S\S \\ S\S\4 SjjrS\ SS4Sjr S\ S\!\ \4SS4Sjr"S\ S\\\ \!\ \444Sjr#S-S\ S \\ S!\\ S"\\ S#\S$\\ S%\S\4S&jjr$S\ S'\ SS4S(jr%S)r&g).ClientaAn 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 9/app/.venv/lib/python3.13/site-packages/gspread/client.py__init__Client.__init__&s 't5idc8URRU5$)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%r*s r&r,Client.get_file_drive_metadata.s 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. )r.r/)_list_spreadsheet_files)r%r.r/files_s r&list_spreadsheet_filesClient.list_spreadsheet_files5s//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 pageTokengetparamsr2 nextPageToken)rr google_sheetsr requestjsonextendr?) r%r.r/r2 page_tokenurlqueryrAresponse response_jsons r&r1Client._list_spreadsheet_filesGs $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)xr.s r&Client.open..~s!F)u,r)NrOr.)r1r StopIterationrrr )r%r.r/spreadsheet_filesrJ propertiesexs ` r&open Client.openkss '+&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') r*N) rr rrJ status_coder NOT_FOUNDr FORBIDDENPermissionError)r%rZ spreadsheetrWs r& open_by_keyClient.open_by_keys %d&6&6s DK  {{&&**>*>>)"++6B>{{&&**>*>>%2-H  s BA/BBrHc6UR[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') )rar)r%rHs 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. rOr.rP)r4rr dict)r%r.rUspreadrQs 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. rOmimeTyper;TparentspostrErAr*)rrCr rDrrEra)r%r.r/payloadrArspreadsheet_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 )rvrw)r export)r%rvrws r&ry Client.exports0&&w&FFr)copy_permissions copy_commentscSR[U5nU[RS.nUbU/US'SS0nURR SXgUS9n U R 5S n URU 5n USLa]URU5n U R5n U H6nURS 5(aMU RUS US US SS9 M8 USLa[U-nSn/nSSSS.nUbXUUS'URR SXS9R 5nURUS5 URSS5nUbMX[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 {}/{}/copyrlNrnr;Trorpr*deleted emailAddresstyperoleF) email_address perm_typernotifyr7z.comments/content,comments/anchor,nextPageTokend)r=includeDeletedr:r>r?r@commentsrBr=)rwrrrCr rDrEralist_permissionsr?sharerrFr*)r%rvr.r{r/r|rHrqrArrrsnew_spreadsheetoriginal permissionsp source_urlrGrresdestination_urlcomments r&copy Client.copysV!!"8'B ..#   "+GI 148    $ $VSv $ N$**>: t #''0H"335K 55##%%"#N"3i6 & ! D 8GDJJHJ"'F (&0{#&&..uj.PUUWJ0 WW_d; (>ASASTO%F#  ((O'&)$ r)clSR[U5nSS0nURRSX#S9 g)zNDeletes a spreadsheet. :param str file_id: a spreadsheet ID (a.k.a file ID). {}/{}r;Tdeleter@N)rwrr rD)r%rvrHrAs r&del_spreadsheetClient.del_spreadsheetZs8 nn3W=148   3 >r)datac [U5[LaURS5nSS0nSR[U5nUR R SU[W5SSSS.US 9 g ) 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. zutf-8z Content-Typeztext/csvrputmediaT) uploadTypeconvertr;)rrAheadersN)rstrencoderwrr rDbytes)r%rvrrqrrHs r& import_csvClient.import_csvdsr, : kk'*G!:.nn:GD    w%%)  ! r)c8URRU5$)z`Retrieve a list of permissions for a file. :param str file_id: a spreadsheet ID (aka file ID). )r r)r%rvs 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%rvrrrrrrs 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%rvrs r&rClient.remove_permissions **7Br)r$)NNr#)NFNT)NNNTNF)'__name__ __module__ __qualname____firstlineno____doc__rr rr rr'rrr,rrr4rr r1rrXrardrirtrPDFrryboolrrr rrrr__static_attributes__rPr)r&rrs &*&0 66'"6$ 6  6<#<#<GKc]6>sm d38n &%)" tDcN#X- ."H9#9(3-9;9<s{$ :s :{ : Xc] d;6G (0C0HSM0[0:2>1A1AGcG3GeG: $!&#'" dd}d d C= d  d dL?s?t?& #& U3:->& 4& P::T#uS$Y?O:O5P0Q: $#'"'+4 4 }4 C= 4 sm 4  4  }4 4  4 lCCSCTCr)rN)"rhttprtypingrrrrrr google.auth.credentialsr requestsr r exceptionsrrr rrrr`rurlsrrrutilsrrrrrrPr)r&rsH::/&5??$ IHuCuCr)