Skip to content

docs: clarify copy_range destination behavior #1591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antoineeripret merged 1 commit into from
Jun 23, 2026
Merged

docs: clarify copy_range destination behavior #1591

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions gspread/worksheet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3283,15 +3283,20 @@ def copy_range(

``paste_type`` values are explained here: `Paste Types`_

See `CopyPasteRequest`_ for how the destination range is filled.

.. _Paste Types: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#pastetype

.. _CopyPasteRequest: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#copypasterequest

: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 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
pasted ex: ``G16``, or a complete range notation ex: ``G16:I20``.
The destination range does not need to match the source dimensions.
If ``dest`` spans a multiple of the source's height or width, the source
is repeated to fill the destination range. If ``dest`` is smaller than the
source, the entire source is copied anyway, beyond the end of ``dest``.
: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``
Expand Down
Loading