a |f@sdZddlZddlZddlmZmZmZmZmZm Z m Z m Z m Z m Z mZmZmZmZmZmZmZddlmZddlmZddlmZmZddlmZdd lmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8ed urdd l9m:Z:ed e;e e;efd ZedddZ?Gddde@ZAGdddZBdS)zW gspread.worksheet ~~~~~~~~~~~~~~~~~ This module contains common worksheets' models. N) TYPE_CHECKINGAnyCallableDictIterableIteratorListLiteralMappingMutableMappingOptionalSequenceTupleType TypedDictTypeVarUnion)Cell)GSpreadException) HTTPClient ParamsType)WORKSHEET_DRIVE_URL)DateTimeOption Dimension GridRangeTypeInsertDataOption MergeTypePasteOrientation PasteTypeTValidationConditionTypeValueInputOptionValueRenderOptiona1_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_gapsfinditemget_a1_from_absolute_rangeis_full_a1_notationnumericise_all rowcol_to_a1 to_recordsT) Spreadsheet CellFormatrangeformat BatchData)r6valuesValueRangeType ValueRange)boundc@seZdZUdZiZeeefed<ee e e ee fe dddZ eedddZeedd d Zdeeeed d dZd S)r;a The 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. _json)clsjsonreturncCs,|dg}||}|d|dd|_|S)Nr9r6majorDimension)r6rA)getr=)r>r?r9Znew_objrCKD:\Projects\storyit_web\backend\venv\Lib\site-packages\gspread/worksheet.py from_jsonxs  zValueRange.from_jsonr@cCs |jdS)zThe range of the valuesr6r=selfrCrCrDr6szValueRange.rangecCs |jdS)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 rArGrHrCrCrDmajor_dimensions zValueRange.major_dimensionN)defaultr@cCs*z|ddWSty$|YS0dS)zpReturns the value of a first cell in a range. If the range is empty, return the default value. rN) IndexError)rIrKrCrCrDfirsts zValueRange.first)N)__name__ __module__ __qualname____doc__r=r str__annotations__ classmethodrr:r rrEpropertyr6rJr rMrCrCrCrDr;Rs #  c@s eZdZdZddeeefeeeedddZ eddd Z e e dd d Z e ddd d Ze edddZe edddZe e dddZe edddZe e dddZe e dddZe e dddZe e dddZe e dddZe edd d!Ze eedd"d#Zeedd$d%Zeeeed&d'd(Zejfeee d)d*d+Z!ejfe e ee d,d-d.Z"e#dee$e d0d1d2Z%ddddd3d3d4e&j'feeee(eeee)eeee&e*e+e$e$efd5 d6d7Z,ddddd3d3d4e&j'feeee(eeee)eeee&e*e+e$e$efd5 d8d9Z-d:ddd/gd3d3fe ee$eeeee.e*ee feee$e/ee*e e0effd;dd?Z2de ee(eeee)e$ed@dAdBZ3ejfe ee$ee*e e0efdCdDdEZ4ee*e e0efe5dFdGdHZ6e e e*e e0efe5dIdJdKZ7e8j9fe$e e8e:eefdLdMdNZ;ddddd3d3d3e&j+feeee(eeee)eeee&e*e+e$e$efd5 dOdPZ<de.eee(eeee)e$e+dQdRdSZ=de.e.eeeeee(ee8eeeeee)e5dT dUdVZ>de.eeefeee8eeeeee)e5dWdXdYZ?e$e@e5dZd[d\ZAe*e$eefe5e5d]d^d_ZBdee ee e5d`dadbZCddceDe eEddfeee5dedfdgZFee5dhdidjZGee5dkdldmZHe5ddndoZIe e5dpdqdrZJe e e(e5dsdtduZKe e e5dvdwdxZLe e e5dydzd{ZMe dd|d}d~ZNe ddddZOe8j9ddd3fePe*ee e0fe8eeQeeee5dddZRe8j9dddfePePe*ee e0fe8eeQeeeee5dddZSd:e8j9d3fePe*ee e0fe e8ee5dddZTd:e8j9d3fePePe*ee e0fe e8ee5dddZUd:e8j9d3fePePe*ee e0fe e8ee5dddZVe#ggdd3d3feePeePeeeeee5dddZWee5dddZXde(e ee e5dddZYde ee e5dddZZde ee e5dddZ[e5dddZ\ePee5dddZ]de^e^e gefe.e ge_e fe*ee`jafeee ee e_e dddZbdePePe*ee e0fee ee e$e dddZcde*ee`jafee ee eee dddZdde*ee`jafee ee ee$e dddZedee ee e5d`ddZfe#deeed0ddZge5dddZheid eee eee ee eeddddZjd!ee ee eeddddZkee5dddZle#emjnfeeedddZoe#ee5d0ddZpd"eee$e$edœddĄZqeedŜddDŽZre:eefddȜddʄZse#eedd˜dd̈́Zte#eedd˜ddτZue:eefddȜddфZve.eddddӄZwe#eddŜddՄZxe#eee5d֜dd؄Zyee5dٜddۄZze e e(e5dܜddބZ{e e e5dߜddZ|e e e5dߜddZ}e e e(e5dܜddZ~e e e5dߜddZe e e5dߜddZe$e5dddZe$e5dddZe e e(e5dܜddZe e e5dߜddZe e e5dߜddZe e e(e5dܜddZe e e5dߜddZe e e5dߜddZee5dddZe5dddZe5dddZee5dddZe5dddZe5dddZejejfeeeee5ddd Zejfeeee5d d d Zd#eee.eeeeeed ddZdS($ WorksheetzUThe class that represents a single sheet in a spreadsheet (aka "worksheet"). Nr3) spreadsheet propertiesspreadsheet_idclientcCsJ|dus drtd|dus&t|ts.td||_||_||_||_dS)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 isinstancerrYrZ _properties _spreadsheet)rIrWrXrYrZrCrCrD__init__s zWorksheet.__init__rFcCsd|jjt|j|jS)Nz <{} {} id:{}>)r7 __class__rNreprtitleidrHrCrCrD__repr__s zWorksheet.__repr__cCs |jdS)z Worksheet ID.sheetIdr^rHrCrCrDrdsz Worksheet.idcCs|jS)zParent spreadsheet)r_rHrCrCrDrWszWorksheet.spreadsheetcCs |jdS)zWorksheet title.rcrgrHrCrCrDrcszWorksheet.titlecCst|j|jfS)zWorksheet URL.)rrYrdrHrCrCrDurlsz Worksheet.urlcCs |jdS)zWorksheet index.indexrgrHrCrCrDriszWorksheet.indexcCs|jddS)zWorksheet hidden status.hiddenFr^rBrHrCrCrD isSheetHiddenszWorksheet.isSheetHiddencCs|jddS)zNumber of rows.gridPropertiesrowCountrgrHrCrCrD row_countszWorksheet.row_countcCs|jddS)zNumber of columns. .. warning:: This value is fetched when opening the worksheet. This is not dynamically updated when adding columns, yet. rm columnCountrgrHrCrCrD col_counts zWorksheet.col_countcCs|jS)zNumber of columns)rqrHrCrCrD column_countszWorksheet.column_countcCs|jdddS)zNumber of frozen rows.rmfrozenRowCountrrkrHrCrCrDfrozen_row_countszWorksheet.frozen_row_countcCs|jdddS)zNumber of frozen columns.rmfrozenColumnCountrrkrHrCrCrDfrozen_col_count szWorksheet.frozen_col_countcCs|jdddS)zZWhether or not gridlines hidden. Boolean. True if hidden. False if shown. rm hideGridlinesFrkrHrCrCrDis_gridlines_hiddenszWorksheet.is_gridlines_hiddencCs|S)z+Tab color style. Hex with RGB color values.) get_tab_colorrHrCrCrD tab_colorszWorksheet.tab_colorcCs0|jdidd}|dur"dStfi|S)z&Tab color style in hex format. String. tabColorStylergbColorN)r^rBr*)rIrzrCrCrDryszWorksheet.get_tab_color)rU default_valuer@cs0jj}tfdd|d}|||S)zAreturn a property of this worksheet or default value if not foundcs|ddjkS)NrXrf)rdxrHrCrD%z/Worksheet._get_sheet_property..sheets)rZfetch_sheet_metadatarYr-rB)rIrUr}metaZsheetrCrHrD_get_sheet_property!s zWorksheet._get_sheet_property)labelvalue_render_optionr@cCs|jt|d|iS)aReturns 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%)rIrrrCrCrDacell*s zWorksheet.acell)rowcolrr@cCs\z8|jt|||tjd}t|tr.|}ntdWntyNd}Yn0t|||S)aReturns 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 ValueRanger[) rBr1rr;r]rMr\KeyErrorr)rIrrrdatavaluerCrCrDrDs     zWorksheet.cellr[)namer@c st|j|}|j|j|}d|vrF|dd}d|vrF|dd}t|}|dg}|dd|d d|d |j}|d |j }|d ur|8}|d ur|8}t |||d }fddt |DS)a'Returns 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() [, ...] :r6r[!rr9 startRowIndexrstartColumnIndex endRowIndexendColumnIndexNrowscolscs@g|]8\}}t|D]&\}}t|d|d|dqqSr)rrr) enumerater.0irjrZ column_offset row_offsetrCrD sz#Worksheet.range..) r&rcrZ values_getrYrBsplitr$rorqr,r) rIr range_labelr grid_ranger9last_row last_columnZ rect_valuesrCrrDr6rs0%      zWorksheet.rangeFT) range_namerJrdate_time_render_optioncombine_merged_cells maintain_size pad_valuesrr@c Cs|j||||||||dS)zAlias for :meth:`~gspread.worksheet.Worksheet.get`... with ``return_type`` set to ``List[List[Any]]`` and ``pad_values`` set to ``True`` (legacy method) rrJrrrrrrrB rIrrJrrrrrrrCrCrD get_valuesszWorksheet.get_valuesc Cs|j||||||||dS)z8Alias to :meth:`~gspread.worksheet.Worksheet.get_values`r)rrrCrCrDget_all_valuess zWorksheet.get_all_valuesr)headexpected_headersr default_blanknumericise_ignore%allow_underscores_in_numeric_literals empty2zeror@c s|j|dd}|ggkrgS||d||d} |dur^tttk} | stdnPt|tt|k} | s~tdtfdd|Dstd t|td gkrnfd d | D} t| S) a Returns 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 handle the simplest use case using a header row (default = 1) and the the reste of the entire sheet. .. note:: for any particular use-case, please get your dataset, your headers 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 str 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)rrrNz`the header row in the worksheet is not unique, try passing 'expected_headers' to get_all_recordsz,the given 'expected_headers' are not uniquesc3s|]}|vVqdSNrC)rheader)keysrCrD Krz,Worksheet.get_all_records..z7the given 'expected_headers' contains unknown headers: allcsg|]}t|qSrC)r0)rr)rrrrrCrDrTsz-Worksheet.get_all_records..)rBlensetrrr2) rIrrrrrrrZ entire_sheetr9Zheader_row_is_uniqueZexpected_headers_are_uniquerC)rrrrrrDget_all_recordss>A     zWorksheet.get_all_recordscCs|S)z2Returns a list of all `Cell` of the current sheet.r6rHrCrCrD get_all_cellsaszWorksheet.get_all_cells)rrJrrr@cCsFz*|d|||||}|r&|dngWSty@gYS0dS)a Returns 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{}:{}rN)rBr7r)rIrrJrrrrCrCrD row_valuesfsA  zWorksheet.row_values)rrr@cCsptd|}d||dd}t|j|}|jj|j||tjdd}z|ddWSt yjgYS0dS) 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)valueRenderOptionrAparamsr9r) r1r7r&rcrZrrYrrr)rIrrZ start_labelrrrrCrCrD col_valuess    zWorksheet.col_values)rrr@cCs|jt|d|iS)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%)rIrrrCrCrD update_acells zWorksheet.update_acell)rrrr@cCs:t|jt||}|jj|j|dtjid|ggid}|S)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') valueInputOptionr9rbody)r&rcr1rZ values_updaterYr" user_entered)rIrrrrrrCrCrDrs  zWorksheet.update_cell) cell_listvalue_input_optionr@cCst|}ttdd|Dtdd|D}ttdd|Dtdd|D}t|jd||}|jj|j |d|id|id }|S) aUpdates 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) css|] }|jVqdSrrrcrCrCrDr%rz)Worksheet.update_cells..css|] }|jVqdSrrrrCrCrDr%rcss|] }|jVqdSrrrrCrCrDr'rcss|] }|jVqdSrrrrCrCrDr'rrrr9r) r(r1minmaxr&rcr7rZrrY)rIrrZ values_rectstartendrrrCrCrD update_cellss' &zWorksheet.update_cellsc stj} |||d} jjj| | d} | dgg} |durhz t| } Wntyfgg} Yn0|dur&jj} t fdd| d}| dg}t fd d |Drt fd d|}|d i}n.d urt }t |}n|did i}t || |dd|ddd} p.d|durtrt }t |}|d|d}|d|d}t| ||d} |tjur| | d<t| S|tjur| Stdd S)azReads values of a single range or a cell of a sheet. Returns a ValueRange (list of lists) containing all values from a specified range or cell By default values are returned as strings. See ``value_render_option`` to change the default format. :param str range_name: (optional) Cell range in the A1 notation or a named range. If not specified the method returns values from all non empty cells. :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` :param bool combine_merged_cells: (optional) If True, then all cells that are part of a merged cell will have the same value as the top-left cell of the merged cell. Defaults to False. .. warning:: Setting this to True will cause an additional API request to be made to retrieve the values of all merged cells. :param bool maintain_size: (optional) If True, then the returned values will have the same size as the requested range_name. Defaults to False. :param bool pad_values: (optional) If True, then empty cells will be filled with empty strings. Defaults to False. .. warning:: The returned array will not be rectangular unless this is set to True. If this is a problem, see also `maintain_size`. :param GridRangeType return_type: (optional) The type of object to return. Defaults to :class:`gspread.utils.GridRangeType.ValueRange`. The other option is `gspread.utils.GridRangeType.ListOfLists`. :rtype: :class:`gspread.worksheet.ValueRange` .. versionadded:: 3.3 Examples:: # Return all values from the sheet worksheet.get() # Return value of 'A1' cell worksheet.get('A1') # Return values of 'A1:B2' range worksheet.get('A1:B2') # Return all values from columns "A" and "B" worksheet.get('A:B') # Return values of 'my_range' named range worksheet.get('my_range') # Return unformatted values (e.g. numbers as numbers) worksheet.get('A2:B4', value_render_option=ValueRenderOption.unformatted) # Return cell values without calculating formulas worksheet.get('A2:B4', value_render_option=ValueRenderOption.formula) rArZdateTimeRenderOptionrr9Tcs|ddjkS)NrXrc)rcr~rHrCrDrrzWorksheet.get..rZ namedRangesc3s$|]}|dr|dkVqdS)rNr)rZ ss_namedRangerrCrDrs z Worksheet.get..cs |dkS)NrrCr~rrCrDrrr6NZ basicFilterrrr)Zworksheet_metadatar9start_row_indexZstart_col_indexr[rrrz4return_type must be either ValueRange or ListOfLists)r&rcrZrrYrBr,rrr-anyr.r$r)r/rr;rE ListOfLists ValueError)rIrrJrrrrrrZget_range_namerresponser9Zspreadsheet_metaZworksheet_metaZ named_rangesZss_named_rangerZa1Za1_rangerrrC)rrIrDrB4sf|                z Worksheet.get)rangesrJrrr@csDfdd|D}|||d}jjj||d}dd|dDS)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']) csg|]}|rtj|qSrCr&rc)rrrHrCrDr@rz'Worksheet.batch_get..r)rrcSsg|]}t|qSrC)r;rE)rrrCrCrDrLrZ valueRanges)rZZvalues_batch_getrY)rIrrJrrrrrCrHrD batch_getsGzWorksheet.batch_get) r9rrawrJrinclude_values_in_responseresponse_value_render_option response_date_time_render_optionr@c Cst|ttfr2t|tr2tjdtdd||}}t|j|} |sV|durPt j nt j }||||d} |j j |j| | ||dd} | S)apSets 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)rincludeValuesInResponseresponseValueRenderOptionresponseDateTimeRenderOption)r9rAr)r]listtuplerRwarningswarnDeprecationWarningr&rcr"rrrZrrY) rIr9rrrJrrrrZfull_range_namerrrCrCrDupdateNs.r  zWorksheet.update)rrrrrrr@c Cs\|s|durtjntj}|D]}t|j|d|d<q|||||d}|jj|j|d} | S)aHSets 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 Tr6)rrrrrr)r"rrr&rcrZZvalues_batch_updaterY) rIrrrrrrr9rrrCrCrD batch_updatesazWorksheet.batch_update)formatsr@cCsndgi}|D]P}|d}|d}t||j}dd|}|dd|d|i|diq |j|j|S) 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 requestsr6r7zuserEnteredFormat(%s),Z repeatCellZuserEnteredFormat)r6rfields)r$rdjoinrappendrZrrY)rIrrr7rZ cell_formatrrrCrCrD batch_formatVs ,  zWorksheet.batch_format)rr7r@cs2t|tr|}n|g}fdd|D}||S)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 csg|]}t|dqS)r5)r4rr6r7rCrDrrz$Worksheet.format..)r]rr)rIrr7Z range_listrrCrrDr7s ( zWorksheet.format)rrr@cCsi}|dur||d<|dur$||d<|s0tdddd|D}dd |j|d |d igi}|j|j|}|dur||jd d<|dur||jd d<|S) zResizes the worksheet. Specify one of ``rows`` or ``cols``. :param int rows: (optional) New number of rows. :param int cols: (optional) New number columns. Nrnrp,Either 'rows' or 'cols' should be specified.rcss|]}d|VqdSzgridProperties/%sNrCrprCrCrDrrz#Worksheet.resize..rupdateSheetPropertiesrfrmrXrrm TypeErrorrrrdrZrrYr^rIrrZgrid_propertiesrrresrCrCrDresizes0zWorksheet.resizer)ascdes)specsr6r@cGs|r,|d\}}t|\}}t|\}}n&|jdddd}d}|j}|j}|j|d||d|d} t} |D]D\} } | dkrd} n| d krd } ntd | d| d }| |qvd d| | digi}|j |j |}|S)aSorts worksheet using given sort orders. :param list specs: The sort order per column. Each sort order represented by a tuple where the first element is a column index and the second element is the order itself: 'asc' or 'des'. :param str range: The range to sort in A1 notation. By default sorts the whole sheet excluding frozen rows. Example:: # Sort sheet A -> 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 rrmrsrr)rfrrrrr Z ASCENDINGrZ DESCENDINGz8Either 'asc' or 'des' should be specified as sort order.)ZdimensionIndexZ sortOrderrZ sortRange)r6Z sortSpecs) rr%r^rBrorqrdrrrrZrrY)rIr6rZstart_a1Zend_a1Z start_rowZ start_colZend_rowZend_colZ request_rangeZrequest_sort_specsrorderZ request_orderZrequest_sort_specrrrCrCrDsortsJ    zWorksheet.sort)rcr@cCs:dd|j|dddigi}|j|j|}||jd<|S)zGRenames the worksheet. :param str title: A new title. rr)rfrcrcrrdrZrrYr^)rIrcrrrCrCrD update_title:s   zWorksheet.update_title)colorr@cCsJt|}dd|jd|idddigi}|j|j|}d|i|jd<|S)zChanges the worksheet's tab color. Use clear_tab_color() to remove the color. :param str color: Hex color value. rrr|rfr{r{r)r+rdrZrrYr^)rIrZ color_dictrrrCrCrDupdate_tab_colorNszWorksheet.update_tab_colorcCs@dd|jddidddigi}|j|j|}|jd|S)z[Clears the worksheet's tab color. Use update_tab_color() to set the color. rrr|Nrr{r)rdrZrrYr^pop)rIrrrCrCrDclear_tab_colorls zWorksheet.clear_tab_color)rir@cCs:dd|j|dddigi}|j|j|}||jd<|S)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 rr)rfririrr)rIrirr rCrCrD update_indexs    zWorksheet.update_index) start_index end_index dimensionr@cCs.ddd|j|||diigi}|j|j|S)aUpdates 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 rZautoResizeDimensions dimensionsrfrZ startIndexZendIndexrdrZrrY)rIrrrrrCrCrD _auto_resizeszWorksheet._auto_resize)start_column_indexend_column_indexr@cCs|||tjS)a3Updates 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 )r rr)rIr!r"rCrCrDcolumns_auto_resizeszWorksheet.columns_auto_resize)r end_row_indexr@cCs|||tjS)a Updates 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 )r rr)rIrr$rCrCrDrows_auto_resizes zWorksheet.rows_auto_resize)rr@cCs|j|j|ddS)zjAdds rows to worksheet. :param rows: Number of new rows to add. :type rows: int )rN)r ro)rIrrCrCrDadd_rowsszWorksheet.add_rows)rr@cCs|j|j|ddS)zpAdds columns to worksheet. :param cols: Number of new columns to add. :type cols: int )rN)r rq)rIrrCrCrDadd_colsszWorksheet.add_cols)r9rinsert_data_option table_rangerr@cCs|j|g||||dS)a"Adds 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 )rr(r)r) append_rows)rIr9rr(r)rrCrCrD append_rowszWorksheet.append_rowc CsVt|j|}|||d}d|i}|j|j|||} t|} |jdd| 7<| S)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 )rZinsertDataOptionrr9rmrn)r&rcrZ values_appendrYrr^) rIr9rr(r)rrrrr  num_new_rowsrCrCrDr*s zWorksheet.append_rows)r9ririnherit_from_beforer@cCs|j|g|||dS)aAdds 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 )rr.) insert_rows)rIr9rirr.rCrCrD insert_rowEs zWorksheet.insert_row)r9rrr.r@c Csd|jvrtd|r&|dkr&tddd|jtj|dt||dd|digi}|j|j|t |jd |}d |i}tj|d }|j |j|||} t|} |j d d | 7<| S)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 spreadsheetrinsertDimensionrr6ZinheritFromBeforezA%srrAr9rmrn) rcrrdrrrrZrrYr&r,r^) rIr9rrr.insert_dimension_bodyrrrr r-rCrCrDr/ls8!   zWorksheet.insert_rows)r9rrr.r@c Cs|r|dkrtddd|jtj|dt||dd|digi}|j|j|t|j t d|}d|i}tj|d}|j |j|||} t|} |j d d | 7<| S) aAdds 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 spreadsheetrr1rr2rr3rmrp) rrdrrrrZrrYr&rcr1r,r^) rIr9rrr.r4rrrr Z num_new_colsrCrCrD insert_colss0  zWorksheet.insert_cols)reditor_users_emailseditor_groups_emails description warning_onlyrequesting_user_can_editr@c CsHt||j}ddd|||||r"dn||ddiigi}|j|j|S)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``. rZaddProtectedRangeZprotectedRangeN)Zusersgroups)r6r8Z warningOnlyZrequestingUserCanEditZeditorsr$rdrZrrY) rIrr6r7r8r9r:rrrCrCrDadd_protected_ranges&/ zWorksheet.add_protected_range)rdr@cCs"ddd|iigi}|j|j|S)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` rZdeleteProtectedRangeZprotectedRangeIdrZrrY)rIrdrrCrCrDdelete_protected_range?s z Worksheet.delete_protected_range)rrrr@cCs|dur |}ddd|j||d|diigi}|j|j|}|durJ|}||d}|tjkrx|jdd|8<n |tjkr|jdd |8<|S) 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``. NrZdeleteDimensionr6rrrmrnrp)rdrZrrYrrr^r)rIrrrrr Z num_deletedrCrCrDdelete_dimensionRs.    zWorksheet.delete_dimension)rrr@cCs|tj||S)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) )r@rrrIrrrCrCrD delete_rowszszWorksheet.delete_rowscCs|tj||S)aKDeletes 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``. )r@rrrArCrCrDdelete_columnss zWorksheet.delete_columnscCs|j|jt|jS)z"Clears all cells in the worksheet.)rZZ values_clearrYr&rcrHrCrCrDclears zWorksheet.clear)rr@cs0fdd|D}d|i}jjj|d}|S)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 csg|]}tj|qSrCr)rrngrHrCrDrrz)Worksheet.batch_clear..rr)rZZvalues_batch_clearrY)rIrrrrCrHrD batch_clearszWorksheet.batch_clear)funcquerycase_sensitivein_row in_columnr@c s|j|jt|j}zt|d}Wnty<g}Yn0||||}t|t rr|t t dfdd } n.t|t j r|t t dfdd } ntd|| |S)Nr9)rr@cs.s|jdur|jkS|jkSdSr)rcasefoldr~)rI str_queryrCrDmatchs z Worksheet._finder..matchcs|jduSr)searchrr~)re_queryrCrDrNszIquery must be of type: 'str' or 're.Pattern' (obtained from re.compile()))rZrrYr&rcr,r _list_cellsr]rRrboolrePatternr ) rIrGrHrIrJrKrr9cellsrNrC)rIrPrMrD_finders$     zWorksheet._finder)r9rJrKr@csrdurdurtddur6fddt|DSdur\fddt|dDSddt|DSdS)z~Returns a list of ``Cell`` instances scoped by optional ``in_row``` or ``in_column`` values (both one-based). Nz3Either 'in_row' or 'in_column' should be specified.c s.g|]&\}}t|dt|ddqSrrrR)rrr)rKrCrDrsz)Worksheet._list_cells..cs&g|]\}}t|dt|dqSrrW)rrr)rJrCrDrsrcSs<g|]4\}}t|D]"\}}t|d|dt|dqqSr)rrrRrrCrCrDrs)r r)rIr9rJrKrC)rKrJrDrQs   zWorksheet._list_cells)rHrJrKrIr@cCs2zt|t||||WSty,YdS0dS)aFinds 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)nextrVfilter StopIterationrIrHrJrKrIrCrCrDfind s zWorksheet.findcCsdd|t||||DS)aFinds 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 cSsg|]}|qSrCrC)relemrCrCrDr1 sz%Worksheet.findall..)rVrYr[rCrCrDfindall szWorksheet.findallcCsi}|dur||d<|dur$||d<|s0tdddd|D}dd |j|d |d igi}|j|j|}|dur||jd d<|dur||jd d<|S) zFreeze rows and/or columns on the worksheet. :param rows: Number of rows to freeze. :param cols: Number of columns to freeze. Nrsrurrcss|]}d|VqdSrrCrrCrCrDrI rz#Worksheet.freeze..rrrrrmrr rCrCrDfreeze6 s0zWorksheet.freezecCsD|durt||jnd|ji}dddd|iiigi}|j|j|S)a*Add 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 NrfrZsetBasicFilterrYr6r<rIrrrrCrCrDset_basic_filter` s zWorksheet.set_basic_filtercCs$ddd|jiigi}|j|j|S)zQRemove the basic filter from a worksheet. .. versionadded:: 3.4 rZclearBasicFilterrfr)rIrrCrCrDclear_basic_filter| s zWorksheet.clear_basic_filter)rZrYsheet_idrWinsert_sheet_index new_sheet_idnew_sheet_namer@c CsFdd||||digi}|||} | dddd} t|| ||S)a Class 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 rZduplicateSheet)Z sourceSheetIdZinsertSheetIndexZ newSheetIdZ newSheetNameZrepliesrrX)rrV) r>rZrYrcrWrdrerfrrrXrCrCrD _duplicate s! zWorksheet._duplicate)rdrerfr@c Cs tj|j|j|j|j|||dS)aDuplicate 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 )rdrerf)rVrgrZrYrdrW)rIrdrerfrCrCrD duplicate szWorksheet.duplicate)destination_spreadsheet_idr@cCs|j|j|j|S)aCopies 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 )rZZspreadsheets_sheets_copy_torYrd)rIrirCrCrDcopy_to s  zWorksheet.copy_to)r merge_typer@cCs0t||j}dd||digi}|j|j|S)adMerge 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 rZ mergeCells)Z mergeTyper6r<)rIrrkrrrCrCrD merge_cells s zWorksheet.merge_cellscCs.t||j}ddd|iigi}|j|j|S)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 rZ unmergeCellsr6r<r`rCrCrD unmerge_cells s  zWorksheet.unmerge_cells)default_empty_valuer@cCs|ddi}|j|j|}|d|jdddig}g}|D]6}|g|dgD]}|d|d |qZq@|S) atReturns a list of lists containing all notes in the sheet. .. 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. Examples:: # Note data: # A B # 1 A1 - # 2 - B2 # Read all notes from the sheet >>> arr = worksheet.get_notes() >>> print(arr) [ ["A1"], ["", "B2"] ] >>> print(gspread.utils.fill_gaps(arr, len(arr), max(len(a) for a in arr), None)) [ ["A1", ""], ["", "B2"] ] rzsheets.data.rowData.values.noterrrrowDatar9rnote)rZspreadsheets_getrYrirBr)rIrnrr rnotesrrrCrCrD get_notes1 s%  zWorksheet.get_notes)rr@c Csrt|j|}|dd}|j|j|}z,|ddddddddd}Wnttfyld }Yn0|S) 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)rrrrrror9rpr[)r&rcrZrqrYrLr)rIrZ absolute_cellrr rprCrCrDget_notea s , zWorksheet.get_note)rrr@cCszdgi}|D]T\}}t|ts2td||dt||jddd|igigdi}|d|q|j |j |dS)aupdate 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 rz4Only string allowed as content for a note: '{} - {}'Z updateCellsrpr9)r6rrN) itemsr]rRr r7r$rdrrZrrY)rIrrrr6contentreqrCrCrD update_notesv s*  zWorksheet.update_notes)rrvr@cCs|||idS)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 NrxrIrrvrCrCrD update_note s zWorksheet.update_notecCs|||idS)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 NryrzrCrCrD insert_note szWorksheet.insert_notecCs||dS)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 Nry)rIrrrCrCrD insert_notes szWorksheet.insert_notescCsdd|D}||dS)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"]`` cSsi|] }|dqS)r[rCrrCrCrD rz)Worksheet.clear_notes..Nry)rIrrrrCrCrD clear_notes szWorksheet.clear_notescCs||didS)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 r[Nry)rIrrCrCrD clear_note szWorksheet.clear_note)rrr@cCs0ddd|t||jdiigi}|j|j|S)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 rZ addNamedRangeZ namedRange)rr6r<)rIrrrrCrCrDdefine_named_range s  zWorksheet.define_named_range)named_range_idr@cCs"ddd|iigi}|j|j|S)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 rZdeleteNamedRangeZ namedRangeIdr>)rIrrrCrCrDdelete_named_range s  zWorksheet.delete_named_range)rrrr@cCs.ddd|j|||diigi}|j|j|S)aT 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` rZaddDimensionGroupr6rrrIrrrrrCrCrD_add_dimension_group0 s zWorksheet._add_dimension_group)rrr@cCs|||tjS)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 )rrrrIrrrCrCrDadd_dimension_group_columnsM sz%Worksheet.add_dimension_group_columnscCs|||tjS)aX 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 )rrrrrCrCrDadd_dimension_group_rows] s z"Worksheet.add_dimension_group_rowscCs.ddd|j|||diigi}|j|j|S)z&delete a dimension group in this sheetrZdeleteDimensionGroupr6rrrrCrCrD_delete_dimension_groupk sz!Worksheet._delete_dimension_groupcCs|||tjS)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 )rrrrrCrCrDdelete_dimension_group_columns sz(Worksheet.delete_dimension_group_columnscCs|||tjS)aT 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 )rrrrrCrCrDdelete_dimension_group_rows s z%Worksheet.delete_dimension_group_rowscCs |dgS)z List all the grouped columns in this worksheet. :returns: list of the grouped columns :rtype: list Z columnGroupsrrHrCrCrDlist_dimension_group_columns sz&Worksheet.list_dimension_group_columnscCs |dgS)z List all the grouped rows in this worksheet. :returns: list of the grouped rows :rtype: list Z rowGroupsrrHrCrCrDlist_dimension_group_rows sz#Worksheet.list_dimension_group_rowscCs6dd|j|||dddiddigi}|j|j|S)a 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` rupdateDimensionPropertiesr hiddenByUserTr6rXrrrrCrCrD_hide_dimension szWorksheet._hide_dimensioncCs|||tjS)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 )rrrrrCrCrD hide_columns s zWorksheet.hide_columnscCs|||tjS)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 )rrrrrCrCrD hide_rows s zWorksheet.hide_rowscCs6dd|j|||dddiddigi}|j|j|S)a 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` rrrrFrrrrCrCrD_unhide_dimension szWorksheet._unhide_dimensioncCs|||tjS)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 )rrrrrCrCrDunhide_columns s zWorksheet.unhide_columnscCs|||tjS)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 )rrrrrCrCrD unhide_rows s zWorksheet.unhide_rows)rjr@cCs:dd|j|dddigi}|j|j|}||jd<|S)z?Send the appropriate request to hide/show the current worksheetrr)rfrjrjrrrIrjrr rCrCrD_set_hidden_flag! s zWorksheet._set_hidden_flagcCs |dS)z(Hides the current worksheet from the UI.TrrHrCrCrDhide6 szWorksheet.hidecCs |dS)z%Show the current worksheet in the UI.FrrHrCrCrDshow: szWorksheet.showcCsBdd|jd|idddigi}|j|j|}||jdd<|S)z,Hide/show gridlines on the current worksheetrrrwrzgridProperties.hideGridlinesrrmrrrCrCrD_set_gridlines_hidden_flag> sz$Worksheet._set_gridlines_hidden_flagcCs |dS)z'Hide gridlines on the current worksheetTrrHrCrCrDhide_gridlinesU szWorksheet.hide_gridlinescCs |dS)z'Show gridlines on the current worksheetFrrHrCrCrDshow_gridlinesY szWorksheet.show_gridlines)sourcedest paste_typepaste_orientationr@cCs8ddt||jt||j||digi}|j|j|S)a>Copies 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` rZ copyPaste)r destination pasteTypeZpasteOrientationr<)rIrrrrrrCrCrD copy_range] s   zWorksheet.copy_range)rrrr@cCsNt||j}ddt||j|d|d|dd|digi}|j|j|S)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` rZcutPasterfrr)rfZrowIndexZ columnIndex)rrrr<)rIrrrZ grid_destrrCrCrD cut_range s  zWorksheet.cut_range)r6condition_typer9 inputMessagestrict showCustomUir@c Cs\t|tstdt||j}dd||dd|Dd|||ddigi}|j|j|S) a7Adds 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.rZsetDataValidationcSsg|] }d|iqS)ZuserEnteredValuerC)rrrCrCrDr sz,Worksheet.add_validation..)typer9) conditionrrr)r6rule)r]r!r r$rdrZrrY) rIr6rr9rrrgridrrCrCrDadd_validation s,6  zWorksheet.add_validation)NN)r[)NNN)NNN)NTNNNNN)TNNNN)NN)N)N)N)NN)NN)NNT)NNT)NN)N)NNN)NNN)r[)NFF)rNrOrPrQr rRrr rr`rerUintrdrWrcrhrirRrlrorqrrrtrvrxrzryr rr# formattedrrrr'rr6rrrrrr;rrrrfloatrrrr JSONResponserrr"rr rrBrrrr4rr7r rr rrrrrr r#r%r&r'r rr+r*r0r/r5r=r?r@rBrCrDrFrrrSrTrVrQr\r^r_rarbrTrgrhrjrZ merge_allrlrmrsrtrxr{r|r}rrrrrrrrrrrrrrrrrrrrrrrrrnormalrrrr!rrCrCrCrDrVs  &    .J    s O %   ; I X   uD 2  + F !     * 2 * K AI  )     ,       *4 ! ! 03         #   #  13rV)CrQrSrtypingrrrrrrrr r r r r rrrrrrr exceptionsr http_clientrrurlsrutilsrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2rWr3rRr4r8rr:rr;rVrCrCrCrDs*L   p      L