KiSrSSKrSSKrSSKJr SSKJrJrJrJ r J r J r J r J r JrJrJrJrJrJrJrJrJr SSKJr SSKJr SSKJrJr SS KJr SS K J!r!J"r"J#r#J$r$J%r%J&r&J'r'J(r(J)r)J*r*J+r+J,r,J-r-J.r.J/r/J0r0J1r1J2r2J3r3J4r4J5r5J6r6J7r7J8r8J9r9J:r:J;r;Jr> \"S \?\\?\4S.5r@\"S\?\ \ \S.5rA\\?\4rB\"SSS9rC"SS\D5rE"SS5rFg)zW gspread.worksheet ~~~~~~~~~~~~~~~~~ This module contains common worksheets' models. NCounter) TYPE_CHECKINGAnyCallableDictIterableIteratorListLiteralMappingMutableMappingOptionalSequenceTupleType TypedDictTypeVarUnion)Cell)GSpreadException) HTTPClient ParamsType)WORKSHEET_DRIVE_URL)DateTimeOption Dimension GridRangeTypeInsertDataOption MergeTypePasteOrientation PasteTypeTTableDirectionValidationConditionTypeValueInputOptionValueRenderOptiona1_range_to_grid_range a1_to_rowcolabsolute_range_namecast_to_a1_notationcell_list_to_rectcombined_merge_valuesconvert_colors_to_hex_valueconvert_hex_to_colors_dict fill_gaps find_tablefinditemget_a1_from_absolute_rangeis_full_a1_notationnumericise_all rowcol_to_a1 to_recordsT) Spreadsheet CellFormatrangeformat BatchData)r;valuesValueRangeType ValueRange)boundc\rSrSr%Sr0r\\\4\S'\ S\ \ S\ \\ 4S\ 4Sj5r\S\4Sj5r\S\4S j5rSS \\S\\4S jjrS rg )r@UaThe class holds the returned values. This class inherit the :const:`list` object type. It behaves exactly like a list. The values are stored in a matrix. The property :meth:`gspread.worksheet.ValueRange.major_dimension` holds the major dimension of the first list level. The inner lists will contain the actual values. Examples:: >>> worksheet.get("A1:B2") [ [ "A1 value", "B1 values", ], [ "A2 value", "B2 value", ] ] >>> worksheet.get("A1:B2").major_dimension ROW .. note:: This class should never be instantiated manually. It will be instantiated using the response from the sheet API. _jsonclsjsonreturncZURS/5nU"U5nUSUSS.UlU$)Nr>r;majorDimension)r;rI)getrD)rErFr>new_objs dC:\Users\julio\OneDrive\Documentos\Trabajo\Ideas Frescas\venv\Lib\site-packages\gspread/worksheet.py from_jsonValueRange.from_json{s;(B'f+']"#34  c URS$)zThe range of the valuesr;rDselfs rLr;ValueRange.rangeszz'""rOc URS$)zThe major dimension of this range Can be one of: * ``ROW``: the first list level holds rows of values * ``COLUMNS``: the first list level holds columns of values rIrQrRs rLmajor_dimensionValueRange.major_dimensionszz*++rONdefaultc8USS$![a Us$f=f)z`Returns the value of a first cell in a range. If the range is empty, return the default value. r) IndexError)rSrXs rLfirstValueRange.firsts)  71:  N s  N)__name__ __module__ __qualname____firstlineno____doc__rDrstr__annotations__ classmethodrr?r rrMpropertyr;rVrr[__static_attributes__r]rOrLr@r@Us!F')E>#s( #(tN+7383D#s##,,,Xc]hsmrOcf\rSrSrSrSSSS\\\4S\\S\\ 4S jjr S \4S jr \ S \ 4S j5r\ SS j5r\ S \4Sj5r\ S \4Sj5r\ S \ 4Sj5r\ S \4Sj5r\ S \ 4Sj5r\ S \ 4Sj5r\ S \ 4Sj5r\ S \ 4Sj5r\ S \ 4Sj5r\ S \4Sj5r\ S \\4Sj5rS \\4SjrS\S\\S \4Sjr\R@4S\S\S \!4Sjjr"\R@4S \ S!\ S\S \!4S"jjr#\$SS$\S \%\!4S%jj5r&SSSSS&S&S'\'RP4S(\\S)\\)S\\S*\\*S+\S,\S-\S.\'S \+\,\%\%\44S/jjr-SSSSS&S&S'\'RP4S(\\S)\\)S\\S*\\*S+\S,\S-\S.\'S \+\,\%\%\44S0jjr.S1SSS#/S&S&4S2\ S3\\%\S\\S4\S5\/\+\\ 4S6\S7\S \%\0\\+\ \1\444S8jjr2S \%\!4S9jr3SS \ S)\\)S\\S*\\*S \%\4 S:jjr4\R@4S!\ S\S \%\\+\ \1\44S;jjr5S\S<\+\ \1\4S \64S=jr7S \ S!\ S<\+\ \1\4S \64S>jr8\9Rt4S?\%\!S@\9S \;\\44SAjjrSSE\/\/\S(\\SF\S)\\)S@\\9SG\\SH\\SI\\*S \64SJjjr?SSK\/\\\4SF\S@\\9SG\\SH\\SI\\*S \64SLjjr@SM\%\AS \64SNjrBSC\+\%\\4SO\6S \64SPjrCSSQ\\ SR\\ S \64SSjjrDSST.SU\E\ \FSV4SW\\S \64SXjjrGSY\S \64SZjrHS[\S \64S\jrIS \64S]jrJS^\ S \64S_jrKS`\ Sa\ Sb\)S \64ScjrLSd\ Se\ S \64SfjrMSg\ Sh\ S \64SijrNSQ\ S S4SjjrOSR\ S S4SkjrP\9RtSSS&4SE\Q\+\\ \14S@\9Sl\\RSm\\SG\S \64 SnjjrS\9RtSSS4SE\Q\Q\+\\ \14S@\9Sl\\RSm\\SG\\S \64 SojjrTS1\9RtS&4SE\Q\+\\ \14S^\ S@\9Sp\S \64 SqjjrUS1\9RtS&4SE\Q\Q\+\\ \14S \ S@\9Sp\S \64 SrjjrVS1\9RtS&4SE\Q\Q\+\\ \14S!\ S@\9Sp\S \64 SsjjrW\$//SS&S&4S$\St\Q\Su\Q\Sv\\Sw\Sx\S \64Syjj5rXSz\S \64S{jrYSSb\)S`\ Sa\\ S \64S|jjrZSS`\ Sa\\ S \64S}jjr[SS`\ Sa\\ S \64S~jjr\S \64Sjr]SC\Q\S \64Sjr^SS\_\_\!/\4\/\!/\`\!4S\+\\aR4S\S\\ S\\ S \`\!4 SjjrcSSE\Q\Q\+\\ \14S\\ S\\ S \%\!4SjjrdSS\+\\aR4S\\ S\\ S\S \\!4 SjjreSS\+\\aR4S\\ S\\ S\S \%\!4 SjjrfSSQ\\ SR\\ S \64Sjjrg\$SS$\\S \4Sjj5rhS \64Sjri\jSS\ S\S\ S\S\\ S\\ S\\S S4Sjj5rkSS\\ S\\ S\\S S4SjjrlS\S \64Sjrm\$\nR4S$\S\S \4Sjj5rp\$S$\S \64Sj5rq\nR4S\%\0\FS\+\\n44S\nS \4SjjrrSS\\S\\S \%\%\4SjjrsS\S \4SjrtS\;\\4S S4Sjru\$S\S\S S4Sj5rv\$S\S\S S4Sj5rwS\;\\4S S4SjrxSC\/\S S4Sjry\$S\S S4Sj5rz\$S$\S(\S \64Sj5r{S\S \64Sjr|S\ S\ Sb\)S \64Sjr}S\ S\ S \64Sjr~S\ S\ S \64SjrS\ S\ Sb\)S \64SjrS\ S\ S \64SjrS\ S\ S \64SjrS \%\64SjrS \%\64SjrS\ S\ Sb\)S \64SjrS\ S\ S \64SjrS\ S\ S \64SjrS\ S\ Sb\)S \64SjrS\ S\ S \64SjrS\ S\ S \64SjrS\S \64SjrS \64SjrS \64SjrS\S \64SjrS \64SjrS \64Sjr\GR$\GR$4S\S\S\S\S \64 Sjjr\GR$4S\S\S\S \64SjjrSSW\S\SE\/\S\\S\S\S \4SjjrS\GR24S\S\S \%\%\4SjjrSrg) WorksheetzMThe class that represents a single sheet in a spreadsheet (aka "worksheet"). N spreadsheetr8 propertiesspreadsheet_idclientcUbO [S5eUb[U[5(d [S5eX0lX@lX lXlg)NzMissing spreadsheet_id parameter, it must be provided with a valid spreadsheet ID. Please allocate new Worksheet object using method like: spreadsheet.get_worksheet(0) zMissing HTTP Client, it must be provided with a valid instance of type gspread.http_client.HTTPClient . Please allocate new Worksheet object using method like: spreadsheet.get_worksheet(0) ) RuntimeError isinstancerrnro _properties _spreadsheet)rSrlrmrnros rL__init__Worksheet.__init__s^  !R  >FJ!?!? - %(rOrGcSRURR[UR5UR 5$)Nz <{} {} id:{}>)r< __class__r_reprtitleidrRs rL__repr__Worksheet.__repr__s5%% NN # #   GG  rOc URS$)z Worksheet ID.sheetIdrsrRs rLr{ Worksheet.ids **rOcUR$)zParent spreadsheet)rtrRs rLrlWorksheet.spreadsheets   rOc URS$)zWorksheet title.rzrrRs rLrzWorksheet.title((rOc@[URUR4-$)zWorksheet URL.)rrnr{rRs rLurl Worksheet.urls#d&9&9477%CCCrOc URS$)zWorksheet index.indexrrRs rLrWorksheet.indexrrOc:URRSS5$)zWorksheet hidden status.hiddenFrsrJrRs rL isSheetHiddenWorksheet.isSheetHiddens##He44rOc&URSS$)zNumber of rows.gridPropertiesrowCountrrRs rL row_countWorksheet.row_counts 01*==rOc&URSS$)zNumber of columns. .. warning:: This value is fetched when opening the worksheet. This is not dynamically updated when adding columns, yet. r columnCountrrRs rL col_countWorksheet.col_counts 01-@@rOcUR$)zNumber of columns)rrRs rL column_countWorksheet.column_counts~~rOc@URSRSS5$)zNumber of frozen rows.rfrozenRowCountrrrRs rLfrozen_row_countWorksheet.frozen_row_counts$ 01556FJJrOc@URSRSS5$)zNumber of frozen columns.rfrozenColumnCountrrrRs rLfrozen_col_countWorksheet.frozen_col_count s$ 01556I1MMrOc@URSRSS5$)zJWhether or not gridlines hidden. Boolean. True if hidden. False if shown. r hideGridlinesFrrRs rLis_gridlines_hiddenWorksheet.is_gridlines_hiddens#  0155ouMMrOc"UR5$)z+Tab color style. Hex with RGB color values.) get_tab_colorrRs rL tab_colorWorksheet.tab_colors!!##rOcxURRS05RSS5nUcg[S0UD6$)z&Tab color style in hex format. String. tabColorStylergbColorNr])rsrJr.)rSrs rLrWorksheet.get_tab_colors>$$(("=AA*dS  *7Y77rOrg default_valuec^TRRTR5n[U4SjUS5nUR X5$)zAreturn a property of this worksheet or default value if not foundc.>USSTR:H$)Nrmr)r{xrSs rL/Worksheet._get_sheet_property..(sa oi0DGG;rOsheets)rofetch_sheet_metadatarnr2rJ)rSrgrmetasheets` rL_get_sheet_propertyWorksheet._get_sheet_property$sA{{//0C0CD ;T(^ yy11rOlabelvalue_render_optionc8UR"[U5SU06$)aAReturns an instance of a :class:`gspread.cell.Cell`. :param label: Cell label in A1 notation Letter case is ignored. :type label: str :param value_render_option: (optional) Determines how values should be rendered in the output. See `ValueRenderOption`_ in the Sheets API. :type value_render_option: :class:`~gspread.utils.ValueRenderOption` .. _ValueRenderOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueRenderOption Example: >>> worksheet.acell('A1') r)cellr))rSrrs rLacellWorksheet.acell-s%,yy5! 8K  rOrowcolcUR[X5U[RS9n[ U[5(aUR 5nO [ S5e[XU5$![a SnNf=f)axReturns an instance of a :class:`gspread.cell.Cell` located at `row` and `col` column. :param row: Row number. :type row: int :param col: Column number. :type col: int :param value_render_option: (optional) Determines how values should be rendered in the output. See `ValueRenderOption`_ in the Sheets API. :type value_render_option: :class:`~gspread.utils.ValueRenderOption` .. _ValueRenderOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueRenderOption Example: >>> worksheet.cell(1, 1) :rtype: :class:`gspread.cell.Cell` )r return_typez(returned data must be of type ValueRange) rJr6rr@rrr[rqKeyErrorr)rSrrrdatavalues rLrWorksheet.cellGsy6 88S&$7)44D$ ++ "#MNN Ce$$ E sA A' A'' A65A6rnamec [URU5nURRURU5nSU;a,UR SS5nSU;aUR S5Sn[U5nUR S/5nUR SS5nUR S S5nUR S UR5nUR S UR5n UbX-nU bX-n [UUU S 9n [U 5V V V Vs/sH/up[U 5Hup[X-S-X-S-US 9PM M1 snn n n $s snn n n f)agReturns a list of :class:`gspread.cell.Cell` objects from a specified range. :param name: A string with range value in A1 notation (e.g. 'A1:A5') or the named range to fetch. :type name: str Alternatively, you may specify numeric boundaries. All values index from 1 (one): :param int first_row: First row number :param int first_col: First column number :param int last_row: Last row number :param int last_col: Last column number :rtype: list Example:: >>> # Using A1 notation >>> worksheet.range('A1:B7') [, ...] >>> # Same with numeric boundaries >>> worksheet.range(1, 1, 7, 2) [, ...] >>> # Named ranges work as well >>> worksheet.range('NamedRange') [, ...] >>> # All values in a single API call >>> worksheet.range() [, ...] :r;r!rr> startRowIndexrstartColumnIndex endRowIndexendColumnIndexrowscolsrrr) r*rzro values_getrnrJsplitr(rrr0 enumerater)rSr range_labelr grid_ranger> row_offset column_offsetlast_row last_column rect_valuesirjrs rLr;Worksheet.rangeusNJ*$**d; {{%%d&9&9;G d?88GR(Dd{zz#q)+D1 (B'^^OQ7 "'91= >>-@ nn%5t~~F    "H  "  (K  $K0 0%cN Q^a'Q->-B% P* Q0   s6E FT range_namerVdate_time_render_optioncombine_merged_cells maintain_size pad_valuesrc .URUUUUUUUUS9$)zAlias for :meth:`~gspread.worksheet.Worksheet.get`... with ``return_type`` set to ``List[List[Any]]`` and ``pad_values`` set to ``True`` (legacy method) rrVrrrrrrrJ rSrrVrrrrrrs rL get_valuesWorksheet.get_valuess2"xx!+ 3$;!5'!#  rOc .URUUUUUUUUS9$)z8Alias to :meth:`~gspread.worksheet.Worksheet.get_values`r)rrs rLget_all_valuesWorksheet.get_all_valuess2!+ 3$;!5'!#  rOrheadexpected_headers default_blanknumericise_ignore%allow_underscores_in_numeric_literals empty2zeroc ^ URUSS9nU//:Xa/$XS- m XSn Sn UcU "T 5n U (a[SU S35eOZU "U5n U (a[SU 35e[U 4S jU55(d#[S [U5[T 5- 35eUS /:XaOU V s/sHn [ U UUUU5PM n n [ T U 5$s sn f) abReturns a list of dictionaries, all of them having the contents of the spreadsheet with the head row as keys and each of these dictionaries holding the contents of subsequent rows of cells as values. This method uses the function :func:`gspread.utils.to_records` to build the resulting records. It mainly wraps around the function and handles the simplest use case using a header row (default = 1) and the rest of the entire sheet. .. note:: For more particular use-cases, please get your dataset, your headers and then use the function :func:`gspread.utils.to_records` to build the records. Cell values are numericised (strings that can be read as ints or floats are converted), unless specified in numericise_ignore :param int head: (optional) Determines which row to use as keys, starting from 1 following the numeration of the spreadsheet. :param list expected_headers: (optional) List of expected headers, they must be unique. .. note:: Returned dictionaries will contain all headers even if not included in this list. :param value_render_option: (optional) Determines how values should be rendered in the output. See `ValueRenderOption`_ in the Sheets API. :type value_render_option: :class:`~gspread.utils.ValueRenderOption` :param Any default_blank: (optional) Determines which value to use for blank cells, defaults to empty string. :param list numericise_ignore: (optional) List of ints of indices of the columns (starting at 1) to ignore numericising, special use of ['all'] to ignore numericising on all columns. :param bool allow_underscores_in_numeric_literals: (optional) Allow underscores in numeric literals, as introduced in PEP 515 :param bool empty2zero: (optional) Determines whether empty cells are converted to zeros when numericised, defaults to False. Examples:: # Sheet data: # A B C # # 1 A1 B2 C3 # 2 A6 B7 C8 # 3 A11 B12 C13 # Read all rows from the sheet >>> worksheet.get_all_records() [ {"A1": "A6", "B2": "B7", "C3": "C8"}, {"A1": "A11", "B2": "B12", "C3": "C13"} ] T)rrrNc\[U5nUVs/sHo!US:dM UPM sn$s snf)Nrr)itemscountsitems rL get_dupes,Worksheet.get_all_records..get_dupes>s,U^F%+@VTd|a/?DV@ @@s ))z5the header row in the worksheet contains duplicates: z[To manually set the header row, use the `expected_headers` parameter of `get_all_records()`z2the given 'expected_headers' contains duplicates: c3,># UH oT;v M g7fr^r]).0headerkeyss rL ,Worksheet.get_all_records..QsE4D&~4Dsz7the given 'expected_headers' contains unknown headers: all)rJrrsetr5r7)rSrrrrrrr entire_sheetr>r duplicatesrrs @rLget_all_recordsWorksheet.get_all_recordssGBxx 3   B4 I1H%e$ A  #"4J&KJ<77##34J&H UE4DEEE&M+,s4y89;  ' " "C!9% "  $'' s1Cc"UR5$)z2Returns a list of all `Cell` of the current sheet.r;rRs rL get_all_cellsWorksheet.get_all_cellsgszz|rOcURSRX5UUU5nU(aUS$/$![a /s$f=f)aReturns a list of all values in a `row`. Empty cells in this list will be rendered as :const:`None`. :param int row: Row number (one-based). :param str major_dimension: (optional) The major dimension of the values. `Dimension.rows` ("ROWS") or `Dimension.cols` ("COLUMNS"). Defaults to Dimension.rows :type major_dimension: :class:`~gspread.utils.Dimension` :param value_render_option: (optional) Determines how values should be rendered in the output. See `ValueRenderOption`_ in the Sheets API. Possible values are: ``ValueRenderOption.formatted`` (default) Values will be calculated and formatted according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. ``ValueRenderOption.unformatted`` Values will be calculated, but not formatted in the reply. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return the number 1.23. ``ValueRenderOption.formula`` Values will not be calculated. The reply will include the formulas. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "=A1". .. _ValueRenderOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueRenderOption :type value_render_option: :class:`~gspread.utils.ValueRenderOption` :param date_time_render_option: (optional) How dates, times, and durations should be represented in the output. Possible values are: ``DateTimeOption.serial_number`` (default) Instructs date, time, datetime, and duration fields to be output as doubles in "serial number" format, as popularized by Lotus 1-2-3. ``DateTimeOption.formatted_string`` Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale). .. note:: This is ignored if ``value_render_option`` is ``ValueRenderOption.formatted``. The default ``date_time_render_option`` is ``DateTimeOption.serial_number``. :type date_time_render_option: :class:`~gspread.utils.DateTimeOption` zA{}:{}r)rJr<r)rSrrVrrrs rL row_valuesWorksheet.row_valueslsRB 88)#' D #47 * * I s.33 AAc[SU5nSRX3SS5n[URU5nURR UR UU[RS.S9nUSS$![a /s$f=f) aReturns a list of all values in column `col`. Empty cells in this list will be rendered as :const:`None`. :param int col: Column number (one-based). :param str value_render_option: (optional) Determines how values should be rendered in the output. See `ValueRenderOption`_ in the Sheets API. :type value_render_option: :class:`~gspread.utils.ValueRenderOption` .. _ValueRenderOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueRenderOption r{}:{}N)valueRenderOptionrIparamsr>r) r6r<r*rzrorrnrrr)rSrr start_labelrrrs rL col_valuesWorksheet.col_valuess$#1c* nn[cr2BC ([A {{%%    %8"+..&  >!$ $ I s.A66 BBrc8UR"[U5SU06$)zUpdates the value of a cell. :param str label: Cell label in A1 notation. :param value: New value. Example:: worksheet.update_acell('A1', '42') r) update_cellr))rSrrs rL update_acellWorksheet.update_acells,u"5DeDDrOc[UR[X55nURR UR US[ R0SU//0S9nU$)zUpdates the value of a cell. :param int row: Row number. :param int col: Column number. :param value: New value. Example:: worksheet.update_cell(1, 1, '42') valueInputOptionr>rbody)r*rzr6ro values_updaternr& user_entered)rSrrrrrs rLrWorksheet.update_cells`)\#5KL {{((    &(8(E(EFeWI& )  rO cell_listvalue_input_optioncj[U5n[[SU55[SU555n[[SU55[SU555n[ UR SR XE55nURRURUSU0SU0S9nU$) a9Updates many cells at once. :param list cell_list: List of :class:`gspread.cell.Cell` objects to update. :param value_input_option: (optional) How the input data should be interpreted. Possible values are: ``ValueInputOption.raw`` (default) The values the user has entered will not be parsed and will be stored as-is. ``ValueInputOption.user_entered`` The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI. See `ValueInputOption`_ in the Sheets API. :type value_input_option: :namedtuple:`~gspread.utils.ValueInputOption` .. _ValueInputOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueInputOption Example:: # Select a range cell_list = worksheet.range('A1:C7') for cell in cell_list: cell.value = 'O_o' # Update in batch worksheet.update_cells(cell_list) c38# UHoRv M g7fr^rrcs rLr)Worksheet.update_cells..+s)y!yc38# UHoRv M g7fr^rr.s rLrr0+s.Hiuuir1c38# UHoRv M g7fr^r-r.s rLrr0-s8iuuir1c38# UHoRv M g7fr^r3r.s rLrr0-s=WYeeYr1rr#r>r$) r,r6minmaxr*rzr<ror&rn)rSr)r* values_rectstartendrrs rL update_cellsWorksheet.update_cellssN( 2  )y) )3.Hi.H+H 38i88#=WY=W:WX(W^^E5OP {{((    &(:;K( )  rOc $^^[TRT5n UUUS.n TRRTRXS9n U R S//5n USLa [ U 5n USLaTRRTR5n [U4SjU S5nU R S/5n[U4SjU55(a#[U4S jU5nUR S 05nOTc.>USSTR:H$)Nrmrz)rzrs rLrWorksheet.get..s!L/'2djj@rOr namedRangesc3d># UH%nURS5(dMTUS:Hv M' g7f)rNr)r ss_namedRangers rLr Worksheet.get..s2%1M $$V,4 mF33%1s00c>UST:H$)Nrr])rrs rLrrAsai:5rOr; basicFilterrrr)worksheet_metadatar>start_row_indexstart_col_indexrrrrz4return_type must be either ValueRange or ListOfLists)r*rzrorrnrJr0rrr2anyr3r(r-r4rr@rM ListOfLists ValueError)rSrrVrrrrrrget_range_namerresponser>spreadsheet_metaworksheet_meta named_rangesss_named_rangera1a1_rangerrs`` rLrJ Worksheet.get:s;x-TZZD.!4$;  ;;))   * h-   "6* 4 '#{{??@S@ST %@ *N ,// rBL%1 "*5|",//< '/ ;3B7 ,// rBFFwPRS *#1 * B */A1 E F %2  D %8%D%D1*=H/9Jm,z//JJD./*=O2PPDvDt> HHrangescUVs/sH!oU(dM [URU5PM# nnUUUS.nURRURXS9nUSVs/sHn[ R U5PM sn$s snfs snf)a% Returns one or more ranges of values from the sheet. :param list ranges: List of cell ranges in the A1 notation or named ranges. :param str major_dimension: (optional) The major dimension of the values. `Dimension.rows` ("ROWS") or `Dimension.cols` ("COLUMNS"). Defaults to Dimension.rows :type major_dimension: :class:`~gspread.utils.Dimension` :param value_render_option: (optional) Determines how values should be rendered in the output. See `ValueRenderOption`_ in the Sheets API. Possible values are: ``ValueRenderOption.formatted`` (default) Values will be calculated and formatted according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. ``ValueRenderOption.unformatted`` Values will be calculated, but not formatted in the reply. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return the number 1.23. ``ValueRenderOption.formula`` Values will not be calculated. The reply will include the formulas. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "=A1". .. _ValueRenderOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueRenderOption :type value_render_option: :class:`~gspread.utils.ValueRenderOption` :param str date_time_render_option: (optional) How dates, times, and durations should be represented in the output. Possible values are: ``DateTimeOption.serial_number`` (default) Instructs date, time, datetime, and duration fields to be output as doubles in "serial number" format, as popularized by Lotus 1-2-3. ``DateTimeOption.formatted_string`` Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale). .. note:: This is ignored if ``value_render_option`` is ``ValueRenderOption.formatted``. The default ``date_time_render_option`` is ``DateTimeOption.serial_number``. :type date_time_render_option: :class:`~gspread.utils.DateTimeOption` .. versionadded:: 3.3 Examples:: # Read values from 'A1:B2' range and 'F12' cell worksheet.batch_get(['A1:B2', 'F12']) r>)rWr valueRanges)r*rzrovalues_batch_getrnr@rM) rSrWrVrrrrrOrs rL batch_getWorksheet.batch_getsN?EJf4%djj!4fJ.!4$;  ;;//   0 2:-1HI1HA $$Q'1HIIKJs BB Br>rawinclude_values_in_responseresponse_value_render_option response_date_time_render_optionc [U[[45(a1[U[5(a[R "S[ SS9 Xp[URU5n U(d%USLa[RO[RnUUUUS.n URRURU U XS.S9n U $)a(Sets values in a cell range of the sheet. :param list values: The data to be written in a matrix format. :param str range_name: (optional) The A1 notation of the values to update. :param bool raw: The values will not be parsed by Sheets API and will be stored as-is. For example, formulas will be rendered as plain strings. Defaults to ``True``. This is a shortcut for the ``value_input_option`` parameter. :param str major_dimension: (optional) The major dimension of the values. `Dimension.rows` ("ROWS") or `Dimension.cols` ("COLUMNS"). Defaults to Dimension.rows :type major_dimension: :class:`~gspread.utils.Dimension` :param str value_input_option: (optional) How the input data should be interpreted. Possible values are: ``ValueInputOption.raw`` (default) The values the user has entered will not be parsed and will be stored as-is. ``ValueInputOption.user_entered`` The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI. :type value_input_option: :class:`~gspread.utils.ValueInputOption` :param response_value_render_option: (optional) Determines how values should be rendered in the output. See `ValueRenderOption`_ in the Sheets API. Possible values are: ``ValueRenderOption.formatted`` (default) Values will be calculated and formatted according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. ``ValueRenderOption.unformatted`` Values will be calculated, but not formatted in the reply. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return the number 1.23. ``ValueRenderOption.formula`` Values will not be calculated. The reply will include the formulas. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "=A1". .. _ValueRenderOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueRenderOption :type response_value_render_option: :class:`~gspread.utils.ValueRenderOption` :param str response_date_time_render_option: (optional) How dates, times, and durations should be represented in the output. Possible values are: ``DateTimeOption.serial_number`` (default) Instructs date, time, datetime, and duration fields to be output as doubles in "serial number" format, as popularized by Lotus 1-2-3. ``DateTimeOption.formatted_string`` Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale). .. note:: This is ignored if ``value_render_option`` is ``ValueRenderOption.formatted``. The default ``date_time_render_option`` is ``DateTimeOption.serial_number``. :type date_time_render_option: :class:`~gspread.utils.DateTimeOption` Examples:: # Sets 'Hello world' in 'A2' cell worksheet.update([['Hello world']], 'A2') # Updates cells A1, B1, C1 with values 42, 43, 44 respectively worksheet.update([[42, 43, 44]]) # Updates A2 and A3 with values 42 and 43 # Note that update range can be bigger than values array worksheet.update([[42], [43]], 'A2:B4') # Add a formula worksheet.update([['=SUM(A1:A4)']], 'A5', raw=False) # Update 'my_range' named range with values 42 and 43 worksheet.update([[42], [43]], 'my_range') # Note: named ranges are defined in the scope of # a spreadsheet, so even if `my_range` does not belong to # this sheet it is still updated .. versionadded:: 3.3 zThe order of arguments in worksheet.update() has changed. Please pass values first and range_name secondor used named arguments (range_name=, values=)) stacklevelT)r#includeValuesInResponseresponseValueRenderOptionresponseDateTimeRenderOption)r>rIr$)rrlisttuplerdwarningswarnDeprecationWarningr*rzr&r^r'ror&rn) rSr>rr^rVr*r_r`rafull_range_namerrOs rLupdateWorksheet.updateTsd j4- 0 0Z5L5L MMA#  "(-djj*E!(+t  $$9I9V9V  !3'A)E,L  ;;,,    "F - rOrcU(d%USLa[RO[RnUHn[URUS5US'M! UUUUUS.nUR R URUS9n U $)aX Sets values in one or more cell ranges of the sheet at once. :param list data: List of dictionaries in the form of `{'range': '...', 'values': [[.., ..], ...]}` where `range` is a target range to update in A1 notation or a named range, and `values` is a list of lists containing new values. :param str value_input_option: (optional) How the input data should be interpreted. Possible values are: * ``ValueInputOption.raw`` The values the user has entered will not be parsed and will be stored as-is. * ``ValueInputOption.user_entered`` The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI. :type value_input_option: :class:`~gspread.utils.ValueInputOption` :param response_value_render_option: (optional) Determines how values should be rendered in the output. See `ValueRenderOption`_ in the Sheets API. Possible values are: ``ValueRenderOption.formatted`` (default) Values will be calculated and formatted according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. ``ValueRenderOption.unformatted`` Values will be calculated, but not formatted in the reply. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return the number 1.23. ``ValueRenderOption.formula`` Values will not be calculated. The reply will include the formulas. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "=A1". .. _ValueRenderOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueRenderOption :type response_value_render_option: :class:`~gspread.utils.ValueRenderOption` :param str response_date_time_render_option: (optional) How dates, times, and durations should be represented in the output. Possible values are: ``DateTimeOption.serial_number`` (default) Instructs date, time, datetime, and duration fields to be output as doubles in "serial number" format, as popularized by Lotus 1-2-3. ``DateTimeOption.formatted_string`` Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale). .. note:: This is ignored if ``value_render_option`` is ``ValueRenderOption.formatted``. The default ``date_time_render_option`` is ``DateTimeOption.serial_number``. :type date_time_render_option: :class:`~gspread.utils.DateTimeOption` Examples:: worksheet.batch_update([{ 'range': 'A1:B1', 'values': [['42', '43']], }, { 'range': 'my_range', 'values': [['44', '45']], }]) # Note: named ranges are defined in the scope of # a spreadsheet, so even if `my_range` does not belong to # this sheet it is still updated .. versionadded:: 3.3 Tr;)r#rerfrgrr%)r&r^r'r*rzrovalues_batch_updatern) rSrr^r*r_r`rar>r%rOs rL batch_updateWorksheet.batch_updatesB"(+t  $$9I9V9V F1$**fWoNF7O!3'A)E,L * ;;2243F3FT2RrOformatsc"S/0nUH`nUSnUSn[X@R5nSSRUR55-nUSR SUSU0US.05 Mb UR R URU5$) aFormats cells in batch. :param list formats: List of ranges to format and the new format to apply to each range. The list is composed of dict objects with the following keys/values: * range : A1 range notation * format : a valid dict object with the format to apply for that range see `CellFormat`_ in the Sheets API for available fields. .. _CellFormat: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#cellformat Examples:: # Format the range ``A1:C1`` with bold text # and format the range ``A2:C2`` a font size of 16 formats = [ { "range": "A1:C1", "format": { "textFormat": { "bold": True, }, }, }, { "range": "A2:C2", "format": { "textFormat": { "fontSize": 16, }, }, }, ] worksheet.batch_format(formats) .. versionadded:: 5.4 requestsr;r<zuserEnteredFormat(%s), repeatCelluserEnteredFormat)r;rfields)r(r{joinrappendrorsrn)rSrur%r<r cell_formatrr{s rL batch_formatWorksheet.batch_format\sX  FJ *K/ GGDJ,sxx 8H8H8J/KKF   # # !+!4k B"(# ${{''(;(;TBBrOr<c[U[5(aUnOU/nUVs/sH n[XBS9PM nnURU5$s snf)aFormat a list of ranges with the given format. :param str|list ranges: Target ranges in the A1 notation. :param dict format: Dictionary containing the fields to update. See `CellFormat`_ in the Sheets API for available fields. Examples:: # Set 'A4' cell's text format to bold worksheet.format("A4", {"textFormat": {"bold": True}}) # Set 'A1:D4' and 'A10:D10' cells's text format to bold worksheet.format(["A1:D4", "A10:D10"], {"textFormat": {"bold": True}}) # Color the background of 'A2:B2' cell range in black, # change horizontal alignment, text color and font size worksheet.format("A2:B2", { "backgroundColor": { "red": 0.0, "green": 0.0, "blue": 0.0 }, "horizontalAlignment": "CENTER", "textFormat": { "foregroundColor": { "red": 1.0, "green": 1.0, "blue": 1.0 }, "fontSize": 12, "bold": True } }) .. versionadded:: 3.3 r:)rrrhr9r)rSrWr< range_listr;rus rLr<Worksheet.formatsNP fd # #J JGQRze:E9zR  ))SsArrc`0nUbXS'UbX#S'U(d [S5eSRSUR555nSSURUS.US .0/0nURR UR U5nUbXRS S'UbX RS S'U$) zResizes the worksheet. Specify one of ``rows`` or ``cols``. :param int rows: (optional) New number of rows. :param int cols: (optional) New number columns. rr,Either 'rows' or 'cols' should be specified.rxc3,# UH nSU-v M g7fzgridProperties/%sNr]rps rLr#Worksheet.resize..R;Qa-1;QrwupdateSheetPropertiesrrrmr{r TypeErrorr|rr{rorsrnrsrSrrgrid_propertiesr{r%ress rLresizeWorksheet.resizes  *.J '  -1M *JK KR?;O;O;QRR +'+ww.='#) .   kk&&t':':DA  =A  - .z :  @D  - .} = rOrspecs)ascdesr;cU(a.URS5up4[U5upV[U5upxO Z by column 'B' wks.sort((2, 'asc')) # Sort range A2:G8 basing on column 'G' A -> Z # and column 'B' Z -> A wks.sort((7, 'asc'), (2, 'des'), range='A2:G8') .. versionadded:: 3.4 rrrrr)rrrrrr ASCENDINGr DESCENDINGz8Either 'asc' or 'des' should be specified as sort order.)dimensionIndex sortOrderrw sortRange)r; sortSpecs) rr)rsrJrrr{rhrMr}rorsrn)rSr;rstart_a1end_a1 start_row start_colend_rowend_col request_rangerequest_sort_specsrorder request_orderrequest_sort_specr%rOs rLsortWorksheet.sorts?, ${{3/ H#/#9 I+F3 GW(()9:>>?OQRSVWWIInnGnnGww&]" )A %  "VJC~ + % ,  N#&'*!   % %&7 8 !.%7"  ;;++D,?,?FrOrzcSSURUS.SS.0/0nURRURU5nXRS'U$)z7Renames the worksheet. :param str title: A new title. rwr)rrzrzrr{rorsrnrs)rSrzr%rOs rL update_titleWorksheet.update_title@s` +26''E&J").  ;;++D,?,?F$)!rOcolorc[U5nSSURSU0S.SS.0/0nURRURU5nSU0UR S'U$)zsChanges the worksheet's tab color. Use clear_tab_color() to remove the color. :param str color: Hex color value. rwrrrrrr)r/r{rorsrnrs)rSr color_dictr%rOs rLupdate_tab_colorWorksheet.update_tab_colorTs06  +'+ww *J.' #2.    ;;++D,?,?F-7,D)rOcSSURSS0S.SS.0/0nURRURU5nURR S5 U$)zKClears the worksheet's tab color. Use update_tab_color() to set the color. rwrrNrrr)r{rorsrnrspop)rSr%rOs rLclear_tab_colorWorksheet.clear_tab_colorrsr +'+ww *D.' #2.   ;;++D,?,?F _-rOrcSSURUS.SS.0/0nURRURU5nXRS'U$)aUpdates the ``index`` property for the worksheet. See the `Sheets API documentation `_ for information on how updating the index property affects the order of worksheets in a spreadsheet. To reorder all worksheets in a spreadsheet, see `Spreadsheet.reorder_worksheets`. .. versionadded:: 3.4 rwr)rrrrr)rSrr%rs rL update_indexWorksheet.update_indexs` +26''E&J").  kk&&t':':DA$)! rO start_index end_index dimensionc~SSSURUUUS.00/0nURRURU5$)aVUpdates the size of rows or columns in the worksheet. Index start from 0 :param start_index: The index (inclusive) to begin resizing :param end_index: The index (exclusive) to finish resizing :param dimension: Specifies whether to resize the row or column :type major_dimension: :class:`~gspread.utils.Dimension` .. versionadded:: 5.3.3 rwautoResizeDimensions dimensionsrr startIndexendIndexr{rorsrn)rSrrrr%s rL _auto_resizeWorksheet._auto_resizesW *$'+ww)2*5(1 '-    {{''(;(;TBBrOstart_column_indexend_column_indexcBURX[R5$)aUpdates the size of rows or columns in the worksheet. Index start from 0 :param start_column_index: The index (inclusive) to begin resizing :param end_column_index: The index (exclusive) to finish resizing .. versionadded:: 3.4 .. versionchanged:: 5.3.3 )rrr)rSrrs rLcolumns_auto_resizeWorksheet.columns_auto_resizes  !3y~~VVrOrI end_row_indexcBURX[R5$)zUpdates the size of rows or columns in the worksheet. Index start from 0 :param start_row_index: The index (inclusive) to begin resizing :param end_row_index: The index (exclusive) to finish resizing .. versionadded:: 5.3.3 )rrr)rSrIrs rLrows_auto_resizeWorksheet.rows_auto_resizes  PPrOc<URURU-S9 g)zRAdds rows to worksheet. :param rows: Number of new rows to add. :type rows: int )rN)rr)rSrs rLadd_rowsWorksheet.add_rows $. /rOc<URURU-S9 g)zXAdds columns to worksheet. :param cols: Number of new columns to add. :type cols: int )rN)rr)rSrs rLadd_colsWorksheet.add_colsrrOinsert_data_option table_rangec*URU/UUUUS9$)aAdds a row to the worksheet and populates it with values. Widens the worksheet if there are more values than columns. :param list values: List of values for the new row. :param value_input_option: (optional) Determines how the input data should be interpreted. See `ValueInputOption`_ in the Sheets API reference. :type value_input_option: :class:`~gspread.utils.ValueInputOption` :param str insert_data_option: (optional) Determines how the input data should be inserted. See `InsertDataOption`_ in the Sheets API reference. :param str table_range: (optional) The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table. Examples: ``A1`` or ``B2:D4`` :param bool include_values_in_response: (optional) Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. .. _ValueInputOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueInputOption .. _InsertDataOption: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append#InsertDataOption )r*rrr_) append_rows)rSr>r*rrr_s rL append_rowWorksheet.append_rows-> H11#'A    rOc[URU5nUUUS.nSU0nURRURXgU5n [ U5n UR SS==U - ss'U $)aAdds multiple rows to the worksheet and populates them with values. Widens the worksheet if there are more values than columns. :param list values: List of rows each row is List of values for the new row. :param value_input_option: (optional) Determines how input data should be interpreted. Possible values are ``ValueInputOption.raw`` or ``ValueInputOption.user_entered``. See `ValueInputOption`_ in the Sheets API. :type value_input_option: :class:`~gspread.utils.ValueInputOption` :param str insert_data_option: (optional) Determines how the input data should be inserted. See `InsertDataOption`_ in the Sheets API reference. :param str table_range: (optional) The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table. Examples: ``A1`` or ``B2:D4`` :param bool include_values_in_response: (optional) Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. .. _ValueInputOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueInputOption .. _InsertDataOption: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append#InsertDataOption )r#insertDataOptionrer>rr)r*rzro values_appendrnlenrs) rSr>r*rrr_rrr%r num_new_rowss rLrWorksheet.append_rowss|@*$**kB !3 2'A  &!kk''(;(;[RVW6{  )*:6,F6 rOinherit_from_beforec(URU/UUUS9$)a9Adds a row to the worksheet at the specified index and populates it with values. Widens the worksheet if there are more values than columns. :param list values: List of values for the new row. :param int index: (optional) Offset for the newly inserted row. :param str value_input_option: (optional) Determines how input data should be interpreted. Possible values are ``ValueInputOption.raw`` or ``ValueInputOption.user_entered``. See `ValueInputOption`_ in the Sheets API. :type value_input_option: :class:`~gspread.utils.ValueInputOption` :param bool inherit_from_before: (optional) If True, the new row will inherit its properties from the previous row. Defaults to False, meaning that the new row acquires the properties of the row immediately after it. .. warning:: `inherit_from_before` must be False when adding a row to the top of a spreadsheet (`index=1`), and must be True when adding to the bottom of the spreadsheet. .. _ValueInputOption: https://developers.google.com/sheets/api/reference/rest/v4/ValueInputOption )r*r) insert_rows)rSr>rr*rs rL insert_rowWorksheet.insert_rowKs+@ H 1 3    rOc"SUR;a [S5eU(aUS:Xa [S5eSSUR[RUS- [ U5U-S- S.US.0/0nUR RURU5 [URS U-5nS U0n[RUS .nUR RURXgU5n [ U5n URS S ==U - ss'U $)aAdds multiple rows to the worksheet at the specified index and populates them with values. :param list values: List of row lists. a list of lists, with the lists each containing one row's values. Widens the worksheet if there are more values than columns. :param int row: Start row to update (one-based). Defaults to 1 (one). :param str value_input_option: (optional) Determines how input data should be interpreted. Possible values are ``ValueInputOption.raw`` or ``ValueInputOption.user_entered``. See `ValueInputOption`_ in the Sheets API. :type value_input_option: :class:`~gspread.utils.ValueInputOption` :param bool inherit_from_before: (optional) If true, new rows will inherit their properties from the previous row. Defaults to False, meaning that new rows acquire the properties of the row immediately after them. .. warning:: `inherit_from_before` must be False when adding rows to the top of a spreadsheet (`row=1`), and must be True when adding to the bottom of the spreadsheet. rztcan't insert row in worksheet with colon ':' in its name. See issue: https://issuetracker.google.com/issues/36761154rzTinherit_from_before cannot be used when inserting row(s) at the top of a spreadsheetrwinsertDimensionrr;inheritFromBeforezA%sr#rIr>rr) rzrr{rrrrorsrnr*rrs) rSr>rr*rinsert_dimension_bodyrrr%rrs rLrWorksheet.insert_rowsrs"B $** "G  3!8"f  %'+ww)2*-'(+F c(9A(= " .A(  !    !4!46KL)$**eckB 02DE"+..FCkk''(;(;[RVW6{  )*:6,F6 rOcU(aUS:Xa [S5eSSUR[RUS- [ U5U-S- S.US.0/0nUR R URU5 [UR[SU55nSU0n[RUS.nUR RURXgU5n [ U5n URS S ==U - ss'U $) a1Adds multiple new cols to the worksheet at specified index and populates them with values. :param list values: List of col lists. a list of lists, with the lists each containing one col's values. Increases the number of rows if there are more values than columns. :param int col: Start col to update (one-based). Defaults to 1 (one). :param str value_input_option: (optional) Determines how input data should be interpreted. Possible values are ``ValueInputOption.raw`` or ``ValueInputOption.user_entered``. See `ValueInputOption`_ in the Sheets API. :type value_input_option: :class:`~gspread.utils.ValueInputOption` :param bool inherit_from_before: (optional) If True, new columns will inherit their properties from the previous column. Defaults to False, meaning that new columns acquire the properties of the column immediately after them. .. warning:: `inherit_from_before` must be False if adding at the left edge of a spreadsheet (`col=1`), and must be True if adding at the right edge of the spreadsheet. rz]inherit_from_before cannot be used when inserting column(s) at the left edge of a spreadsheetrwrrrr#rrr) rr{rrrrorsrnr*rzr6rrs) rSr>rr*rrrrr%r num_new_colss rL insert_colsWorksheet.insert_colss> 3!8"o  %'+ww)2*-'(+F c(9A(= " .A(  !    !4!46KL)$**l1c6JK 02DE"+..FCkk''(;(;[RVW6{  )*=9\I9 rOeditor_users_emailseditor_groups_emails description warning_onlyrequesting_user_can_editc [XR5nSSSUUUUU(aSOUUS.S.00/0nURRURU5$)a]Add protected range to the sheet. Only the editors can edit the protected range. Google API will automatically add the owner of this SpreadSheet. The list ``editor_users_emails`` must at least contain the e-mail address used to open that SpreadSheet. ``editor_users_emails`` must only contain e-mail addresses who already have a write access to the spreadsheet. :param str name: A string with range value in A1 notation, e.g. 'A1:A5'. Alternatively, you may specify numeric boundaries. All values index from 1 (one): :param int first_row: First row number :param int first_col: First column number :param int last_row: Last row number :param int last_col: Last column number For both A1 and numeric notation: :param list editor_users_emails: The email addresses of users with edit access to the protected range. This must include your e-mail address at least. :param list editor_groups_emails: (optional) The email addresses of groups with edit access to the protected range. :param str description: (optional) Description for the protected ranges. :param boolean warning_only: (optional) When true this protected range will show a warning when editing. Defaults to ``False``. :param boolean requesting_user_can_edit: (optional) True if the user who requested this protected range can edit the protected cells. Defaults to ``False``. rwaddProtectedRangeprotectedRangeN)usersgroups)r;r warningOnlyrequestingUserCanEditeditorsr(r{rorsrn) rSrrrrrrrr%s rLadd_protected_rangeWorksheet.add_protected_ranges|^,D'':  '(%/+6+75M$0!%.A.B&" +* .{{''(;(;TBBrOr{c`SSSU00/0nURRURU5$)zDelete protected range identified by the ID ``id``. To retrieve the ID of a protected range use the following method to list them all: :func:`~gspread.Spreadsheet.list_protected_ranges` rwdeleteProtectedRangeprotectedRangeIdrorsrn)rSr{r%s rLdelete_protected_range Worksheet.delete_protected_rangeEsD **B- {{''(;(;TBBrOcfUcUnSSSURUUS- US.00/0nURRURU5nUcUnX2- S-nU[R :XaUR SS==U-ss'U$U[R:XaUR SS==U-ss'U$) aDeletes multi rows from the worksheet at the specified index. :param dimension: A dimension to delete. ``Dimension.rows`` or ``Dimension.cols``. :type dimension: :class:`~gspread.utils.Dimension` :param int start_index: Index of a first row for deletion. :param int end_index: Index of a last row for deletion. When ``end_index`` is not specified this method only deletes a single row at ``start_index``. rwdeleteDimensionr;rrrrr)r{rorsrnrrrsr)rSrrrr%r num_deleteds rLdelete_dimensionWorksheet.delete_dimensionXs  #I %'+ww)2*5/(1 "(    kk&&t':':DA  #I-1   &   - .z :k I : ).. (   - .} = L = rOcBUR[RX5$)aDeletes multiple rows from the worksheet at the specified index. :param int start_index: Index of a first row for deletion. :param int end_index: Index of a last row for deletion. When end_index is not specified this method only deletes a single row at ``start_index``. Example:: # Delete rows 5 to 10 (inclusive) worksheet.delete_rows(5, 10) # Delete only the second row worksheet.delete_rows(2) )rrrrSrrs rL delete_rowsWorksheet.delete_rowss&$$Y^^[LLrOcBUR[RX5$)a#Deletes multiple columns from the worksheet at the specified index. :param int start_index: Index of a first column for deletion. :param int end_index: Index of a last column for deletion. When end_index is not specified this method only deletes a single column at ``start_index``. )rrrrs rLdelete_columnsWorksheet.delete_columnss$$Y^^[LLrOctURRUR[UR55$)z"Clears all cells in the worksheet.)ro values_clearrnr*rzrRs rLclearWorksheet.clears.{{''   !4TZZ!@  rOcUVs/sHn[URU5PM nnSU0nURRURUS9nU$s snf)aClears multiple ranges of cells with 1 API call. `Batch Clear`_ .. _Batch Clear: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchClear Examples:: worksheet.batch_clear(['A1:B1','my_range']) # Note: named ranges are defined in the scope of # a spreadsheet, so even if `my_range` does not belong to # this sheet it is still updated .. versionadded:: 3.8.0 rWrq)r*rzrovalues_batch_clearrn)rSrWrngr%rOs rL batch_clearWorksheet.batch_clearsZ$CII&3%djj#6&I&!;;11$2E2ED1Q Js Afuncquerycase_sensitivein_row in_columnc^^ ^ URRUR[UR55n[ US5nURXtU5n[U[5(aUm S[S[4UU 4Sjjn OA[U[R5(aUm S[S[4U 4Sjjn O [S5eU"X5$![ a /nNf=f)Nr>rrGc>T(d URcURT:H$URR5TR5:H$r^)rcasefold)rr$ str_querys rLmatch Worksheet._finder..matchs>!QWW_77i//77++-1C1C1EEErOc>>TRUR5SL$r^)searchr)rre_querys rLr+r,sqww/t;;rOzIquery must be of type: 'str' or 're.Pattern' (obtained from re.compile()))rorrnr*rzr0r _list_cellsrrrdrboolrePatternr) rSr"r#r$r%r&rr>cellsr+r/r*s ` @@rL_finderWorksheet._finders{{%%   !4TZZ!@  tH~.F  ; eS ! !I F F$ F F rzz * *H < <$ < <[ E!!3 F sC C#"C#cUbUb [S5eUb:[U5VVs/sH!upE[US-U[XSS- 5S9PM# snn$Ub9[XS- 5VVs/sHupg[X&S-[U5S9PM snn$[U5VVVVs/sH4upE[U5Hupg[US-US-[U5S9PM! M6 snnnn$s snnfs snnfs snnnnf)znReturns a list of ``Cell`` instances scoped by optional ``in_row``` or ``in_column`` values (both one-based). z3Either 'in_row' or 'in_column' should be specified.rr)rrrrd)rSr>r%r&rrrrs rLr0Worksheet._list_cellss   )"7QR R  (//FAQIS]9K5LM/  !*&!*< = =HAU#e*= = (//FA )#HAQAEU< .=/   s(C%"C";C( c d[UR[XX#55$![a gf=f)a@Finds the first cell matching the query. :param query: A literal string to match or compiled regular expression. :type query: str, :py:class:`re.RegexObject` :param int in_row: (optional) One-based row number to scope the search. :param int in_column: (optional) One-based column number to scope the search. :param bool case_sensitive: (optional) comparison is case sensitive if set to True, case insensitive otherwise. Default is True. Does not apply to regular expressions. :returns: the first matching cell or None otherwise :rtype: :class:`gspread.cell.Cell` N)nextr5filter StopIteration)rSr#r%r&r$s rLfindWorksheet.find s1(  VUFVW W  s " //c\UR[XX#5Vs/sHnUPM sn$s snf)aaFinds all cells matching the query. Returns a list of :class:`gspread.cell.Cell`. :param query: A literal string to match or compiled regular expression. :type query: str, :py:class:`re.RegexObject` :param int in_row: (optional) One-based row number to scope the search. :param int in_column: (optional) One-based column number to scope the search. :param bool case_sensitive: (optional) comparison is case sensitive if set to True, case insensitive otherwise. Default is True. Does not apply to regular expressions. :returns: the list of all matching cells or empty list otherwise :rtype: list )r5r;)rSr#r%r&r$elems rLfindallWorksheet.findall s62 VUFV V V   s )c`0nUbXS'UbX#S'U(d [S5eSRSUR555nSSURUS.US .0/0nURR UR U5nUbXRS S'UbX RS S'U$) zFreeze rows and/or columns on the worksheet. :param rows: Number of rows to freeze. :param cols: Number of columns to freeze. rrrrxc3,# UH nSU-v M g7frr]rs rLr#Worksheet.freeze..O rrrwrrrrrrs rLfreezeWorksheet.freeze< s  04, -  37/ 0JK KR?;O;O;QRR +'+ww.='#) .   kk&&t':':DA  CG  - ./? @  FJ  - ./B C rOcUb[XR5O SUR0nSSSSU000/0nURRURU5$)aAdd a basic filter to the worksheet. If a range or boundaries are passed, the filter will be limited to the given range. :param str name: A string with range value in A1 notation, e.g. ``A1:A5``. Alternatively, you may specify numeric boundaries. All values index from 1 (one): :param int first_row: First row number :param int first_col: First column number :param int last_row: Last row number :param int last_col: Last column number .. versionadded:: 3.4 rrwsetBasicFilterr;r;rrSrrr%s rLset_basic_filterWorksheet.set_basic_filterf se( #4 1TWW%  .GZ;P0QRST{{''(;(;TBBrOctSSSUR00/0nURRURU5$)zARemove the basic filter from a worksheet. .. versionadded:: 3.4 rwclearBasicFilterrr)rSr%s rLclear_basic_filterWorksheet.clear_basic_filter sH &!477) {{''(;(;TBBrOsheet_idinsert_sheet_index new_sheet_idnew_sheet_namecpSSUUUUS.0/0nURX(5n U SSSSn [XJX!5$)aClass method to duplicate a :class:`gspread.worksheet.Worksheet`. :param Session client: The HTTP client used for the HTTP request :param str spreadsheet_id: The spreadsheet ID (used for the HTTP request) :param int sheet_id: The original sheet ID :param int insert_sheet_index: (optional) The zero-based index where the new sheet should be inserted. The index of all sheets after this are incremented. :param int new_sheet_id: (optional) The ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict with any existing sheet ID. If set, it must be non-negative. :param str new_sheet_name: (optional) The name of the new sheet. If empty, a new name is chosen for you. :returns: a newly created :class:`gspread.worksheet.Worksheet`. .. note:: This is a class method in order for the spreadsheet class to use it without an instance of a Worksheet object rwduplicateSheet) sourceSheetIdinsertSheetIndex newSheetId newSheetNamerepliesrrm)rsrj) rErornrQrlrRrSrTr%rrms rL _duplicateWorksheet._duplicate seB $)1,>&2(6 '   "">8)_Q'(89,G .IIrOc [RURURURUR UUUS9$)a>Duplicate the sheet. :param int insert_sheet_index: (optional) The zero-based index where the new sheet should be inserted. The index of all sheets after this are incremented. :param int new_sheet_id: (optional) The ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict with any existing sheet ID. If set, it must be non-negative. :param str new_sheet_name: (optional) The name of the new sheet. If empty, a new name is chosen for you. :returns: a newly created :class:`gspread.worksheet.Worksheet`. .. versionadded:: 3.1 )rRrSrT)rjr\rornr{rl)rSrRrSrTs rL duplicateWorksheet.duplicate sE*## KK    GG   1%)$  rOdestination_spreadsheet_idcdURRURURU5$)zCopies this sheet to another spreadsheet. :param str spreadsheet_id: The ID of the spreadsheet to copy the sheet to. :returns: a dict with the response containing information about the newly created sheet. :rtype: dict )rospreadsheets_sheets_copy_tornr{)rSras rLcopy_toWorksheet.copy_to s-{{66   *D  rO merge_typec[XR5nSSX#S.0/0nURRURU5$)aMerge cells. :param str name: Range name in A1 notation, e.g. 'A1:A5'. :param merge_type: (optional) one of ``MergeType.merge_all``, ``MergeType.merge_columns``, or ``MergeType.merge_rows``. Defaults to ``MergeType.merge_all``. See `MergeType`_ in the Sheets API reference. :type merge_type: :namedtuple:`~gspread.utils.MergeType` Alternatively, you may specify numeric boundaries. All values index from 1 (one): :param int first_row: First row number :param int first_col: First column number :param int last_row: Last row number :param int last_col: Last column number :returns: the response body from the request :rtype: dict .. _MergeType: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#MergeType rw mergeCells) mergeTyper;r)rSrrfrr%s rL merge_cellsWorksheet.merge_cells sJ0,D'':  ,j(VWX {{''(;(;TBBrOc[XR5nSSSU00/0nURRURU5$)aUnmerge cells. Unmerge previously merged cells. :param str name: Range name in A1 notation, e.g. 'A1:A5'. Alternatively, you may specify numeric boundaries. All values index from 1 (one): :param int first_row: First row number :param int first_col: First column number :param int last_row: Last row number :param int last_col: Last column number :returns: the response body from the request :rtype: dict rw unmergeCellsr;rrJs rL unmerge_cellsWorksheet.unmerge_cells sT(,D'':  "% {{''(;(;TBBrOmergesr;ric UVs/sH1nS[USUR5URSU5S.0PM3 nnURR UR SU05$s snf)aMerge multiple ranges at the same time. :param merges: list of dictionaries with the ranges(is A1-notation), and an optional ``MergeType`` field. See `MergeType`_ in the Sheets API reference. :type merges: List[Dict[Literal["range", "mergeType"], Union[str, MergeType]]] :params merge_type: (optional) default ``MergeType`` for all merges missing the merges. defaults to ``MergeType.merge_all``. :type merge_type: ``MergeType`` example:: worksheet.batch_merge( [ {"range": "A1:M1"}, {"range": "D2:H2", "mergeType": utils.MergeType.merge_rows} ] ) :returns: The body of the request response. :rtype: dict rhr;rirqrw)r(r{rJrorsrn)rSrprfmergerws rL batch_mergeWorksheet.batch_merge7 s|F    3E'NDGGL!&; !C     {{''(;(;j(=STT s8A'default_empty_valuerctS[URU5S.nURRURU5nUSSSSR S0/5n/nUHQnUR /5 UR S/5H'nUSR UR S U55 M) MS U$) ajReturns a list of lists containing all notes in the sheet or range. .. note:: The resulting matrix is not necessarily square. The matrix is as tall as the last row with a note, and each row is only as long as the last column in that row with a note. Please see the example below. To ensure it is square, use `gspread.utils.fill_gaps`, for example like `utils.fill_gaps(arr, len(arr), max(len(a) for a in arr), None)` :param str default_empty_value: (optional) Determines which value to use for cells without notes, defaults to None. :param str grid_range: (optional) Range name in A1 notation, e.g. 'A1:A5'. Examples:: # Note data: # A B # 1 A1 - # 2 - B2 # Read all notes from the sheet >>> worksheet.get_notes() [ ["A1"], ["", "B2"] ] >>> arr = worksheet.get_notes() >>> gspread.utils.fill_gaps(arr, len(arr), max(len(a) for a in arr), None) [ ["A1", ""], ["", "B2"] ] # Read notes from a specific range >>> worksheet.get_notes(grid_range="A2:B2") [ ["", "B2"] ] zsheets.data.rowData.values.note)r{rWrrrrowDatar>rnote)r*rzrospreadsheets_getrnrJr}) rSrvrrrrnotesrrs rL get_notesWorksheet.get_notes_ s`8)$**jA  kk**4+>+>G8}Q'*..y2$?!#C LL "-b   &2E!FG.  rOrc[URU5nUSS.nURRURU5nUSSSSSSSSSnU$![ [ 4a S nU$f=f) zGet the content of the note located at `cell`, or the empty string if the cell does not have a note. :param str cell: A string with cell coordinates in A1 notation, e.g. 'D7'. zsheets/data/rowData/values/note)rWr{rrrrxr>ryr)r*rzrorzrnrZr)rSr absolute_cellrrrys rLget_noteWorksheet.get_note s,DJJ= #7 kk**4+>+>G x=#F+A.y9!)r;r{rN) rrrrdrr<r(r{r}rorsrn)rSr{r%r;contentreqs rL update_notesWorksheet.update_notes s*1;B/?#kkmNEgs++JQQ3E77C$%$*G!"' C   # #C (1,4   !4!4d;rOrc(URX05 g)zUpdate the content of the note located at `cell`. :param str cell: A string with cell coordinates in A1 notation, e.g. 'D7'. :param str note: The text note to insert. .. versionadded:: 3.7 NrrSrrs rL update_noteWorksheet.update_note s 4/*rOc(URX05 g)aInsert a note. The note is attached to a certain cell. :param str cell: A string with cell coordinates in A1 notation, e.g. 'D7'. :param str content: The text note to insert. Alternatively, you may specify numeric boundaries. All values index from 1 (one): :param int first_row: First row number :param int first_col: First column number :param int last_row: Last row number :param int last_col: Last column number .. versionadded:: 3.7 Nrrs rL insert_noteWorksheet.insert_note s$ 4/*rOc&URU5 g)ainsert multiple notes. The notes are attached to a certain cell. :param notes dict: A dict of notes with their cells coordinates and respective content dict format is: * key: the cell coordinates as A1 range format * value: the string content of the cell Example:: { "D7": "Please read my notes", "GH42": "this one is too far", } .. versionadded:: 5.9 Nr)rSr{s rL insert_notesWorksheet.insert_notes s& % rOcTUVs0sHo"S_M nnURU5 gs snf)zClear all notes located at the at the coordinates pointed to by ``ranges``. :param ranges list: List of A1 coordinates where to clear the notes. e.g. ``["A1", "GH42", "D7"]`` rNr)rSrWr;r{s rL clear_notesWorksheet.clear_notes s-)//u/ % 0s %c*URUS05 g)aClear a note. The note is attached to a certain cell. :param str cell: A string with cell coordinates in A1 notation, e.g. 'D7'. Alternatively, you may specify numeric boundaries. All values index from 1 (one): :param int first_row: First row number :param int first_col: First column number :param int last_row: Last row number :param int last_col: Last column number .. versionadded:: 3.7 rNr)rSrs rL clear_noteWorksheet.clear_note& s$ 4*%rOcSSSU[XR5S.00/0nURRURU5$)a :param str name: A string with range value in A1 notation, e.g. 'A1:A5'. Alternatively, you may specify numeric boundaries. All values index from 1 (one): :param int first_row: First row number :param int first_col: First column number :param int last_row: Last row number :param int last_col: Last column number :param range_name: The name to assign to the range of cells :returns: the response body from the request :rtype: dict rw addNamedRange namedRange)rr;r)rSrrr%s rLdefine_named_rangeWorksheet.define_named_range: sV( #$$.%;D''%J'&   {{''(;(;TBBrOnamed_range_idc`SSSU00/0nURRURU5$)z :param str named_range_id: The ID of the named range to delete. Can be obtained with Spreadsheet.list_named_ranges() :returns: the response body from the request :rtype: dict rwdeleteNamedRange namedRangeIdr )rSrr%s rLdelete_named_rangeWorksheet.delete_named_range[ sD &&) {{''(;(;TBBrOr9r:c~SSSURUUUS.00/0nURRURU5$)a update this sheet by grouping 'dimension' :param int start: The start (inclusive) of the group :param int end: The end (exclusive) of the grou :param str dimension: The dimension to group, can be one of ``ROWS`` or ``COLUMNS``. :type diension: :class:`~gspread.utils.Dimension` rwaddDimensionGroupr;rrrSr9r:rr%s rL_add_dimension_groupWorksheet._add_dimension_groupn sW ''+ww)2*/(+ "*    {{''(;(;TBBrOcBURX[R5$)a Group columns in order to hide them in the UI. .. note:: API behavior with nested groups and non-matching ``[start:end)`` range can be found here: `Add Dimension Group Request`_ .. _Add Dimension Group Request: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#AddDimensionGroupRequest :param int start: The start (inclusive) of the group :param int end: The end (exclusive) of the group )rrrrSr9r:s rLadd_dimension_group_columns%Worksheet.add_dimension_group_columns s((Y^^DDrOcBURX[R5$)a  Group rows in order to hide them in the UI. .. note:: API behavior with nested groups and non-matching ``[start:end)`` range can be found here `Add Dimension Group Request`_ :param int start: The start (inclusive) of the group :param int end: The end (exclusive) of the group )rrrrs rLadd_dimension_group_rows"Worksheet.add_dimension_group_rows s((Y^^DDrOc~SSSURUUUS.00/0nURRURU5$)z&delete a dimension group in this sheetrwdeleteDimensionGroupr;rrrs rL_delete_dimension_group!Worksheet._delete_dimension_group sW *'+ww)2*/(+ "-    {{''(;(;TBBrOcBURX[R5$)a Remove the grouping of a set of columns. .. note:: API behavior with nested groups and non-matching ``[start:end)`` range can be found here `Delete Dimension Group Request`_ .. _Delete Dimension Group Request: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#DeleteDimensionGroupRequest :param int start: The start (inclusive) of the group :param int end: The end (exclusive) of the group )rrrrs rLdelete_dimension_group_columns(Worksheet.delete_dimension_group_columns s++E GGrOcBURX[R5$)a Remove the grouping of a set of rows. .. note:: API behavior with nested groups and non-matching ``[start:end)`` range can be found here `Delete Dimension Group Request`_ :param int start: The start (inclusive) of the group :param int end: The end (exclusive) of the group )rrrrs rLdelete_dimension_group_rows%Worksheet.delete_dimension_group_rows s++E GGrOc&URS/5$)ze List all the grouped columns in this worksheet. :returns: list of the grouped columns :rtype: list columnGroupsrrRs rLlist_dimension_group_columns&Worksheet.list_dimension_group_columns s'';;rOc&URS/5$)z_ List all the grouped rows in this worksheet. :returns: list of the grouped rows :rtype: list rowGroupsrrRs rLlist_dimension_group_rows#Worksheet.list_dimension_group_rows s'' R88rOcSSURUUUS.SS0SS.0/0nURRURU5$)aR Update this sheet by hiding the given 'dimension' Index starts from 0. :param int start: The (inclusive) start of the dimension to hide :param int end: The (exclusive) end of the dimension to hide :param str dimension: The dimension to hide, can be one of ``ROWS`` or ``COLUMNS``. :type diension: :class:`~gspread.utils.Dimension` rwupdateDimensionPropertiesr hiddenByUserTr;rmr{rrs rL_hide_dimensionWorksheet._hide_dimension se /'+ww)2*/(+ "+D'#1 2  &{{''(;(;TBBrOcBURX[R5$)z Explicitly hide the given column index range. Index starts from 0. :param int start: The (inclusive) starting column to hide :param int end: The (exclusive) end column to hide )rrrrs rL hide_columnsWorksheet.hide_columns ##E ??rOcBURX[R5$)z Explicitly hide the given row index range. Index starts from 0. :param int start: The (inclusive) starting row to hide :param int end: The (exclusive) end row to hide )rrrrs rL hide_rowsWorksheet.hide_rows rrOcSSURUUUS.SS0SS.0/0nURRURU5$)aY Update this sheet by unhiding the given 'dimension' Index starts from 0. :param int start: The (inclusive) start of the dimension to unhide :param int end: The (inclusive) end of the dimension to unhide :param str dimension: The dimension to hide, can be one of ``ROWS`` or ``COLUMNS``. :type dimension: :class:`~gspread.utils.Dimension` rwrrrFrrrs rL_unhide_dimensionWorksheet._unhide_dimension& se /'+ww)2*/(+ "+E'#1 2  &{{''(;(;TBBrOcBURX[R5$)z Explicitly unhide the given column index range. Index start from 0. :param int start: The (inclusive) starting column to hide :param int end: The (exclusive) end column to hide )rrrrs rLunhide_columnsWorksheet.unhide_columnsI %%e)..AArOcBURX[R5$)z Explicitly unhide the given row index range. Index start from 0. :param int start: The (inclusive) starting row to hide :param int end: The (exclusive) end row to hide )rrrrs rL unhide_rowsWorksheet.unhide_rowsT rrOrcSSURUS.SS.0/0nURRURU5nXRS'U$)z?Send the appropriate request to hide/show the current worksheetrwr)rrrrrrSrr%rs rL_set_hidden_flagWorksheet._set_hidden_flag_ se +'+ww&,'#+ .   kk&&t':':DA%+" rOc$URS5$)z(Hides the current worksheet from the UI.TrrRs rLhideWorksheet.hidet s$$T**rOc$URS5$)z%Show the current worksheet in the UI.FrrRs rLshowWorksheet.showx s$$U++rOcSSURSU0S.SS.0/0nURRURU5nXRSS'U$)z,Hide/show gridlines on the current worksheetrwrrrzgridProperties.hideGridlinesrrrrs rL_set_gridlines_hidden_flag$Worksheet._set_gridlines_hidden_flag| ss +'+ww //' #A.    kk&&t':':DA>D)*?; rOc$URS5$)z'Hide gridlines on the current worksheetTrrRs rLhide_gridlinesWorksheet.hide_gridlines s..t44rOc$URS5$)z'Show gridlines on the current worksheetFrrRs rLshow_gridlinesWorksheet.show_gridlines s..u55rOsourcedest paste_typepaste_orientationcSS[XR5[X R5UUS.0/0nURRURU5$)aCopies a range of data from source to dest .. note:: ``paste_type`` values are explained here: `Paste Types`_ .. _Paste Types: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#pastetype :param str source: The A1 notation of the source range to copy :param str dest: The A1 notation of the destination where to paste the data Can be the A1 notation of the top left corner where the range must be paste ex: G16, or a complete range notation ex: G16:I20. The dimensions of the destination range is not checked and has no effect, if the destination range does not match the source range dimension, the entire source range is copies anyway. :param paste_type: the paste type to apply. Many paste type are available from the Sheet API, see above note for detailed values for all values and their effects. Defaults to ``PasteType.normal`` :type paste_type: :class:`~gspread.utils.PasteType` :param paste_orientation: The paste orient to apply. Possible values are: ``normal`` to keep the same orientation, ``transpose`` where all rows become columns and vice versa. :type paste_orientation: :class:`~gspread.utils.PasteOrientation` rw copyPaste)r destination pasteTypepasteOrientationr)rSrrrrr%s rL copy_rangeWorksheet.copy_range s]> "8"I'=dGG'L%/,= "   {{''(;(;TBBrOc[X R5nSS[XR5USUSUSS.US.0/0nURRURU5$)aMoves a range of data form source to dest .. note:: ``paste_type`` values are explained here: `Paste Types`_ .. _Paste Types: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#pastetype :param str source: The A1 notation of the source range to move :param str dest: The A1 notation of the destination where to paste the data **it must be a single cell** in the A1 notation. ex: G16 :param paste_type: the paste type to apply. Many paste type are available from the Sheet API, see above note for detailed values for all values and their effects. Defaults to ``PasteType.normal`` :type paste_type: :class:`~gspread.utils.PasteType` rwcutPasterrr)rrowIndex columnIndex)rrrr)rSrrr grid_destr%s rL cut_rangeWorksheet.cut_range s~4+49  "8"I'0';(1/(B+45G+H( &0!    {{''(;(;TBBrOcondition_type inputMessagestrict showCustomUic  [U[5(d [S5e[XR5nSSUUUVs/sHnSU0PM snS.UUUS.S.0/0n UR R URU 5$s snf)aGAdds a data validation rule to any given range. .. note:: ``condition_type`` values are explained here: `ConditionType`_ .. _ConditionType: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#ConditionType :param str source: The A1 notation of the source range to move :param condition_type: The sort of condition to apply. :param values: List of condition values. :type values: Any :param str inputMessage: Message to show for the validation. :param bool strict: Whether to reject invalid data or not. :param bool showCustomUi: Whether to show a custom UI(Dropdown) for list values. **Examples** .. code-block:: python import gspread from gspread.utils import ValidationConditionType ... ws = spreadsheet.sheet1 ws.add_validation( 'A1', ValidationConditionType.number_greater, [10], strict=True, inputMessage='Value must be greater than 10', ) ws.add_validation( 'C2:C7', ValidationConditionType.one_of_list, ['Yes','No'], showCustomUi=True ) z?condition_type param should be a valid ValidationConditionType.rwsetDataValidationuserEnteredValue)typer>) conditionrrr)r;rule)rrr%rr(r{rorsrn) rSr;rr>rrrgridrr%s rLadd_validationWorksheet.add_validation sl.*ABBQ &eWW5 '!%)7OU+"OUe&8%%@v+"* -9&,,8 ! * *{{''(;(;TBB+"sB A1top_left_range_name directionc8URSS9n[X1U5$)aExpands a cell range based on non-null adjacent cells. Expand can be done in 3 directions defined in :class:`~gspread.utils.TableDirection` * ``TableDirection.right``: expands right until the first empty cell * ``TableDirection.down``: expands down until the first empty cell * ``TableDirection.table``: expands right until the first empty cell and down until the first empty cell In case of empty result an empty list is restuned. When the given ``start_range`` is outside the given matrix of values the exception :class:`~gspread.exceptions.InvalidInputValue` is raised. Example:: values = [ ['', '', '', '', '' ], ['', 'B2', 'C2', '', 'E2'], ['', 'B3', 'C3', '', 'E3'], ['', '' , '' , '', 'E4'], ] >>> utils.find_table(TableDirection.table, 'B2') [ ['B2', 'C2'], ['B3', 'C3'], ] .. note:: the ``TableDirection.table`` will look right from starting cell then look down from starting cell. It will not check cells located inside the table. This could lead to potential empty values located in the middle of the table. .. note:: when it is necessary to use non-default options for :meth:`~gspread.worksheet.Worksheet.get`, please get the data first using desired options then use the function :func:`gspread.utils.find_table` to extract the desired table. :param str top_left_range_name: the top left corner of the table to expand. :param gspread.utils.TableDirection direction: the expand direction :rtype list(list): the resulting matrix T)r)rJr1)rSrrr>s rLexpandWorksheet.expandJ s"dT*&yAArO)rsrtrorn)NN)rGr8)r)NNN)NTNNNNN)TNNNNr^)NNT)rN)NFF)r_r`rarbrcrrdrrrrur|rgintr{rlrzrrr1rrrrrrrrrr#rr' formattedrrrr+r r;rrLrrrr@rrr rfloatr rrr JSONResponser rr&r^r r;rJr\rnrsr9rr<rrr rrrrrrrrrrrrrrrrrrr rrrrr rr r2r3r5r0r=rArFrKrOrfr\r_rdr merge_allrjrnrtr|rrrrrrrrrrrrrrrrrrrrrrrrrrrrrr"normalr!rrr%r r$tablerrhr]rOrLrjrjs)-'+ $("$(#38,$(! $( $ $(L # +C++!!)s))DSDD)s))5t55 >3>>A3AAcK#KKN#NNNTNN $8C=$$8x}82C2 2PQ22C1L1L  /    <2C1L1L ,% ,%,%/ ,%  ,%\F #F tDzF F T%)/3;?<@%*#%2%>%> SM "), &&78  "*.!9  #    #  z4S ?* + <%)/3;?<@%*#%2%>%> SM "), &&78  "*.!9  #    #  z4S ?* + 204;?796; t(t(#49-t(&&78 t(  t( $E#s(O4 t(04t(t( d3c5#o../ 0t(ltDz04;?<@ J J"),J&&78 J "*.!9 J c J^2C1L1L# #/# huS%_-. / #J E# EeCO.D E E ).sE3)? 60@/C/C7:7-7 c  7v%)/3;?<@%*# %2%=%=CQSMCQ"),CQ&&78 CQ "*.!9 CQ # CQCQCQ#CQ z4S ?* +CQP04;?<@ SJ SJ"),SJ&&78 SJ "*.!9 SJ j  SJp%)/39=59DHEIQ#'QSMQ Q "), Q %%56 Q%-TNQ'//@&AQ+3>*BQ Ql9=59DHEIs~c3h/0ss%%56 s %-TN s '//@&A s+3>*Bs sjACD$4ACACF/*DIsN+/*5A/* /*dAE(SM(08 ( (VQUDC!667D@H D DL#,(cl<.#,6CC+.C;DC C@W"%W9<W W Q" Q36 Q  Q0S0T00S0T00@/C/C9=%)+0 % sC/0% -% %%56 % c] % %) %  % T0@/C/C9=%)59 -%S%"89:---%%56 - c] - %-TN - -d/?/C/C$) % sC/0% % - % " %  % T/?/C/C$) F%S%"89:FF- F " F  FV/?/C/C$) ?%S%"89:??- ? " ?  ?B.0.0%)").GCGC&c]GC'sm GC c] GC  GC#'GC GCGCRCCC(RV&"&14&AI#& &R<@MM+3C=M M,<@ M M+3C= M  M | (3-L>!%#' '"$.?$OP'"S"**_%'" '"  '" C= '" $'"X!%#' %S%"89: C=  d @!%#'# S"**_% C=    $ 8!%#'#  S"**_%   C=    d  :AE(SM(08 ( (TCXc]CcCC6CLC"-1&*(,0J0J0J 0J  0J %SM 0Jsm0J! 0J 0J0Jh-1&*(,  $SM sm !    > $'   7@7J7JCCCsCC>C#C,CCH!* 3 3&UT'"67sI~9NNOP&U&U &UT.0$(>%c]>SM> d3i >@SS*1<'#s("31<1.E.E +C+C+C +C , +C  +Cb!* 0 0 ,C,C,C ,C  ,Cf'+"RCRC0RC RC sm RC  RCRC RCl$($2$8$83B 3B"3B d3i 3B3BrOrj)Grcr2rj collectionsrtypingrrrrr r r r r rrrrrrrrrr exceptionsr http_clientrrurlsrutilsrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7rlr8rdr9r=rr?rhr@rjr]rOrLr!s ((/%>D( #s(#  kSDcO#L M c3h' )>IIX\3B\3BrO