Skip to content
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

Jump to bottom

Fixed default value of merge_type parameter in merge_cells function docstring. #1373

Merged
merged 3 commits into from
Dec 31, 2023
Merged

Fixed default value of merge_type parameter in merge_cells function docstring. #1373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6ec732
Correct the default value of docstring of merge_cells
neolooong Dec 26, 2023
7c42555
use namedtuple instead string of merge_type
neolooong Dec 28, 2023
72eca6b
add test for merge_cells and unmerge_cells
neolooong Dec 30, 2023
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
1 change: 1 addition & 0 deletions docs/api/utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Utils
.. autonamedtuple:: gspread.utils.Dimension
.. autonamedtuple:: gspread.utils.DateTimeOption
.. autonamedtuple:: gspread.utils.ExportFormat
.. autonamedtuple:: gspread.utils.MergeType
.. autonamedtuple:: gspread.utils.MimeType
.. autonamedtuple:: gspread.utils.PasteOrientation
.. autonamedtuple:: gspread.utils.PasteType
Expand Down
4 changes: 4 additions & 0 deletions gspread/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,10 @@
"NORMAL", "TRANSPOSE"
)

MergeType = namedtuple("MergeType", ["merge_all", "merge_columns", "merge_rows"])(
"MERGE_ALL", "MERGE_COLUMNS", "MERGE_ROWS"
)

DEPRECATION_WARNING_TEMPLATE = (
"[Deprecated][in version {v_deprecated}]: {msg_deprecated}"
)
Expand Down
11 changes: 6 additions & 5 deletions gspread/worksheet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from .utils import (
REQUIRED_KWARGS,
Dimension,
MergeType,
PasteOrientation,
PasteType,
ValueInputOption,
Expand Down Expand Up @@ -2541,14 +2542,14 @@ def copy_to(
return self.spreadsheet._spreadsheets_sheets_copy_to(self.id, spreadsheet_id)

@cast_to_a1_notation
def merge_cells(self, name, merge_type="MERGE_ALL"):
"""Merge cells. There are 3 merge types: ``MERGE_ALL``, ``MERGE_COLUMNS``,
and ``MERGE_ROWS``.
def merge_cells(self, name, merge_type=MergeType.merge_all):
"""Merge cells.

:param str name: Range name in A1 notation, e.g. 'A1:A5'.
:param str merge_type: (optional) one of ``MERGE_ALL``,
``MERGE_COLUMNS``, or ``MERGE_ROWS``. Defaults to ``MERGE_ROWS``.
: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):
Expand Down
Loading