vji@dZddlmZddlmZddlmZmZmZmZm Z m Z ddl m Z ddl mZmZddlmZmZdd lmZmZmZdd lmZdd lmZmZdd lmZmZmZm Z Gd dZ!y)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_urlfinditemceZdZdZdefdedeededdfdZ e dee fdZ d+d ee eeeeffddfd Zd edefd Z d,d eedeedeeeeffdZ d,d eedeedeeeeefeffdZd+d edeedefdZdedefdZdedefdZd+d eedeefdZd+d edeedefdZej@fdedede!fdZ" d-ded eede#deede#def dZ$deddfdZ%dede ee!fdefd Z&dedeeee ee#fffd!Z' d.ded"eed#eed$eed%e#d&eed'e#defd(Z(ded)eddfd*Z)y)/Clienta7An 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_clientreturnc ||||_yN)r)selfrrrs A/var/www/html/venv/lib/python3.12/site-packages/gspread/client.py__init__zClient.__init__#s 'tW5cB|jjjS)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 )rrexpiry)r#s r$r(z Client.expiry+s$$+++r&timeoutc:|jj|y)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+zClient.set_timeout7s $$W-r&idc8|jj|S)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). )rget_file_drive_metadata)r#r,s r$r.zClient.get_file_drive_metadataDs 77;;r&title folder_idc2|j||\}}|S)a:List 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/r0)_list_spreadsheet_files)r#r/r0files_s r$list_spreadsheet_fileszClient.list_spreadsheet_filesKs"//ey/Qq r&cBg}d}t}dtjd}|r |d|dz }|r |d|dz }|ddddd } |r||d <|jj d || }|j } |j | d | jdd}| ||fSc)Nz mimeType=""z and name = "z and parents in "iTz:kind,nextPageToken,files(id,name,createdTime,modifiedTime))qpageSizesupportsAllDrivesincludeItemsFromAllDrivesfields pageTokengetparamsr3 nextPageToken)rr google_sheetsrrequestjsonextendr?) r#r/r0r3 page_tokenurlqueryrAresponse response_jsons r$r2zClient._list_spreadsheet_files]s $X334A6  }UG1- -E  ( 15 5E!%)-R  &0{#''//s6/JH$MMOM LLw/ 0&**?DAJ!hr&c|j|\}} tfd|}|d|d<t |j |S#t$r}t||d}~wwxYw)a.Opens 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|dk(S)Nname)xr/s r$zClient.open..s!F)u,r&NrNr/)r2r StopIterationrrr)r#r/r0spreadsheet_filesrJ propertiesexs ` r$openz Client.opensu '+&B&B5)&T#8 8!,!J)0 74++Z88  8%h/R 7 8sA A AAkeyc4 t|jd|i}|S#t$rr}|jjt j k(rt|j||jjt jk(rt||d}~wwxYw)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) rrrrJ status_coder NOT_FOUNDr FORBIDDENPermissionError)r#rW spreadsheetrUs r$ open_by_keyzClient.open_by_keys %d&6&6s DK  {{&&**>*>>)"++6B>{{&&**>*>>%2-H  s BA-BBrHc6|jt|S)aOpens 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') )r^r)r#rHs r$ open_by_urlzClient.open_by_urls 3C 899r&c |j|}|r|Dcgc] }||dk(s |}}|Dcgc]&}t|jtdd|di|(c}Scc}wcc}w)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. rNr/rO)r5rrdict)r#r/rSspreadrPs r$openallzClient.openalls!77> %6!!%6&>:Q! ! '  (($*DQvY*D!*D E  ! s AA+A#c|tjd}ddi}||g|d<|jjdt||}|j d}|j |S)aCreates 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. rNmimeTyper;TparentspostrErAr,)rrCrrDrrEr^)r#r/r0payloadrArspreadsheet_ids r$createz Client.creates ..#     "+GI     $ $ * % $//r&file_idformatc<|jj||S)aExport 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 )rorp)rexport)r#rorps r$rrz Client.exports 0&&wv&FFr&copy_permissions copy_commentsc djt|}|tjd}||g|d<ddi}|jj d|||} | j d } |j| } |dur|j|} | j} | D]}|jd rd }t|d d k(rt|d }nt|d dvrt|d}| j|t|d t|dd|durt|z}d }g}dddd}|Z||d<|jj d||j }|j|d|jdd}|Zt| jz}dd i}|D]!}|jj d|||#| S)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 {}/{}/copyrfNrhr;Trirjr,deletedr7typedomain)usergroup emailAddressroleF) email_address perm_typer|notifyz.comments/content,comments/anchor,nextPageTokend)r=includeDeletedr:r>r?r@commentsrBr=)rprrrCrrDrEr^list_permissionsr?strsharerrFr,)r#ror/rsr0rtrHrkrArlrmnew_spreadsheetoriginal permissionspemail_or_domain source_urlrGrresdestination_urlcomments r$copyz Client.copy s&V!!"8'B ..#   "+GI 148    $ $VSwv $ N$**>: t #''0H"335K  55# #%qy>X-&)!H+&6O6^'88&)!N*;&ASASTO%F#   ((O'&)  r&ctdjt|}ddi}|jjd||y)z^Deletes a spreadsheet. :param str file_id: a spreadsheet ID (a.k.a file ID). z{}/{}r;Tdeleter@N)rprrrD)r#rorHrAs r$del_spreadsheetzClient.del_spreadsheetzs: nn3W=148   3v >r&datac:|jj||S)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#rors r$rzClient.import_csvs***7D99r&c8|jj|S)zpRetrieve a list of permissions for a file. :param str file_id: a spreadsheet ID (aka file ID). )rr)r#ros r$rzClient.list_permissionss 0099r&valuer~r|r email_message with_linkc D|jj|||||||S)apCreates 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' ) )rinsert_permission)r#rorr~r|rrrs r$rzClient.insert_permissions-d11 UItV]I  r& permission_idc<|jj||y)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)rremove_permission)r#rors r$rzClient.remove_permissions **7MBr&r")NN)NFNT)NNNTNF)*__name__ __module__ __qualname____doc__rr rr rr%propertyrr(r floatr r+rrr.rrr5r r2rrVr^r`rdrnrPDFbytesrrboolrrrrrrrOr&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 exceptionsrrrrrrr]rurlsrrutilsrrrrrrOr&r$rsA::/&5??$IHHGCGCr&