Dorothydu's picture
Upload 50 random repository samples
9d3c8f5 verified
from googleapiclient.errors import HttpError
import sys
import re
import os
import pytest
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
import pygsheets
from pygsheets.exceptions import CannotRemoveOwnerError
from pygsheets.custom_types import ExportType
from pygsheets import Cell
import pygsheets.utils as utils
from pygsheets.custom_types import HorizontalAlignment, VerticalAlignment
try:
# for python 2.x
import ConfigParser
except ImportError:
# for python 3.6+
import configparser as ConfigParser
CONFIG_FILENAME = os.path.join(os.path.dirname(__file__), 'data/tests.config')
SERVICE_FILE_NAME = os.path.join(os.path.dirname(__file__), 'auth_test_data/pygsheettest_service_account.json')
PYTHON_VERSION = str(sys.hexversion)
def read_config(filename):
config = ConfigParser.ConfigParser()
config.readfp(open(filename))
return config
test_config = None
pygsheet_client = None
def setup_module(module):
global test_config, pygsheet_client
try:
test_config = read_config(CONFIG_FILENAME)
except IOError as e:
msg = "Can't find %s for reading test configuration. "
raise Exception(msg % e.filename)
try:
pygsheet_client = pygsheets.authorize(service_account_file=SERVICE_FILE_NAME)
except IOError as e:
msg = "Can't find %s for reading credentials. "
raise Exception(msg % e.filename)
config_title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
sheets = pygsheet_client.open_all(query="name = '{}'".format(config_title))
for sheet in sheets:
sheet.delete()
def teardown_module(module):
config_title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
sheets = pygsheet_client.open_all(query="name = '{}'".format(config_title))
for sheet in sheets:
try:
sheet.delete()
except HttpError as err:
# do not delete files which the test suite has no permission for.
if err.resp['status'] == '403':
pass
else:
raise
# @pytest.mark.skip()
class TestClient(object):
def setup_class(self):
title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
self.spreadsheet = pygsheet_client.create(title)
def teardown_class(self):
self.spreadsheet.delete()
def test_open_title(self):
title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
spreadsheet = pygsheet_client.open(title)
assert(isinstance(spreadsheet, pygsheets.Spreadsheet))
assert spreadsheet.title == title
def test_open_key(self):
title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
spreadsheet = pygsheet_client.open_by_key(self.spreadsheet.id)
assert(isinstance(spreadsheet, pygsheets.Spreadsheet))
assert spreadsheet.id == self.spreadsheet.id
assert spreadsheet.title == title
def test_open_url(self):
url = test_config.get('Spreadsheet', 'url').format(self.spreadsheet.id)
spreadsheet = pygsheet_client.open_by_url(url)
assert(isinstance(spreadsheet, pygsheets.Spreadsheet))
assert spreadsheet.id == self.spreadsheet.id
# TODO: Expand create tests.
def test_create(self):
title = 'test_create_file' + PYTHON_VERSION
result = pygsheet_client.create(title)
assert isinstance(result, pygsheets.Spreadsheet)
assert title == result.title
result.delete()
def test_create_in_folder_by_id(self):
result = None
folder_id = None
exception = None
# We catch any exceptions here to make sure we clean up the folder and sheet that are created during testing
try:
folder_title = 'test_create_file_in_folder_folder' + PYTHON_VERSION
sheet_title = 'test_create_file_in_folder_sheet' + PYTHON_VERSION
folder_id = pygsheet_client.drive.create_folder(folder_title)
result = pygsheet_client.create(sheet_title, folder=folder_id)
assert isinstance(result, pygsheets.Spreadsheet)
assert sheet_title == result.title
except Exception as e:
exception = e
# Clean up sheet and folder
if folder_id:
pygsheet_client.drive.delete(folder_id)
if result:
result.delete()
if exception:
pytest.fail(str(exception))
# @pytest.mark.skip()
class TestSpreadSheet(object):
def setup_class(self):
title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
self.spreadsheet = pygsheet_client.create(title)
self.output_path = test_config.get('Output', 'path').format(PYTHON_VERSION)
if not os.path.exists(self.output_path):
os.mkdir(self.output_path)
def teardown_class(self):
self.spreadsheet.delete()
for root, dirs, files in os.walk(self.output_path):
for file in files:
os.remove(root + file)
os.rmdir(self.output_path)
def test_properties(self):
json_sheet = self.spreadsheet._jsonsheet
assert self.spreadsheet.id == json_sheet['spreadsheetId']
assert self.spreadsheet.title == json_sheet['properties']['title']
assert self.spreadsheet.defaultformat == json_sheet['properties']['defaultFormat']
assert isinstance(self.spreadsheet.sheet1, pygsheets.Worksheet)
def test_workssheet_add_del(self):
self.spreadsheet.add_worksheet("testSheetx", 50, 60)
try:
wks = self.spreadsheet.worksheet_by_title("testSheetx")
except pygsheets.WorksheetNotFound:
pytest.fail()
assert wks.rows == 50
assert wks.cols == 60
self.spreadsheet.del_worksheet(wks)
with pytest.raises(pygsheets.WorksheetNotFound):
self.spreadsheet.worksheet_by_title("testSheetx")
def test_worksheet_opening(self):
wkss = self.spreadsheet.worksheets()
assert isinstance(wkss, list)
assert isinstance(wkss[0], pygsheets.Worksheet)
assert isinstance(self.spreadsheet.worksheet(), pygsheets.Worksheet)
def add_worksheet(self):
self.spreadsheet.add_worksheet("dummy_temp_wks", 100, 50)
wks = self.spreadsheet.worksheet_by_title("dummy_temp_wks")
assert isinstance(wks, pygsheets.Worksheet)
assert wks.rows == 100
assert wks.cols == 50
def delete_worksheet(self):
wks = self.spreadsheet.worksheet_by_title("dummy_temp_wks")
self.spreadsheet.del_worksheet(wks)
with pytest.raises(pygsheets.WorksheetNotFound):
self.spreadsheet.worksheet_by_title("dummy_temp_wks")
def test_updated(self):
RFC_3339 = (r'\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?'
r'(Z|[+-]\d{2}:\d{2})')
has_match = re.match(RFC_3339, self.spreadsheet.updated) is not None
assert has_match
def test_find(self):
self.spreadsheet.add_worksheet('testFind1', 10, 10)
self.spreadsheet.add_worksheet('testFind2', 10, 10)
self.spreadsheet.worksheet('title', 'testFind1').update_row(1, ['test', 'test'])
self.spreadsheet.worksheet('title', 'testFind2').update_row(1, ['test', 'test'])
cells = self.spreadsheet.find('test')
assert isinstance(cells, list)
assert len(cells) == 3
assert len(cells[0]) == 0
assert len(cells[1]) == 2
self.spreadsheet.del_worksheet(self.spreadsheet.worksheet('title', 'testFind1'))
self.spreadsheet.del_worksheet(self.spreadsheet.worksheet('title', 'testFind2'))
def test_export(self):
wks_1 = self.spreadsheet.sheet1
wks_1.update_row(1, ['test', 'test', 'test', 'test'])
self.spreadsheet.add_worksheet('Test2')
wks_2 = self.spreadsheet.worksheet('title', 'Test2')
wks_2.update_row(1, ['test', 'test', 'test', 'test'])
self.spreadsheet.export(filename='test', path=self.output_path)
self.spreadsheet.export(file_format=ExportType.XLSX, filename='test', path=self.output_path)
self.spreadsheet.export(file_format=ExportType.HTML, filename='test', path=self.output_path)
self.spreadsheet.export(file_format=ExportType.ODS, filename='test', path=self.output_path)
self.spreadsheet.export(file_format=ExportType.PDF, filename='test', path=self.output_path)
assert os.path.exists('{}/test.pdf'.format(self.output_path))
assert os.path.exists('{}/test.xlsx'.format(self.output_path))
assert os.path.exists('{}/test.ods'.format(self.output_path))
assert os.path.exists('{}/test.zip'.format(self.output_path))
self.spreadsheet.export(filename='spreadsheet', path=self.output_path)
assert os.path.exists('{}/spreadsheet0.csv'.format(self.output_path))
assert os.path.exists('{}/spreadsheet1.csv'.format(self.output_path))
self.spreadsheet.export(file_format=ExportType.TSV, filename='tsv_spreadsheet', path=self.output_path)
assert os.path.exists('{}/tsv_spreadsheet0.tsv'.format(self.output_path))
assert os.path.exists('{}/tsv_spreadsheet1.tsv'.format(self.output_path))
wks_1.clear()
self.spreadsheet.del_worksheet(wks_2)
def test_permissions(self):
old_per = self.spreadsheet.permissions
assert isinstance(old_per, list)
self.spreadsheet.share('pygsheettest2@gmail.com')
assert len(self.spreadsheet.permissions) == (len(old_per) + 1)
self.spreadsheet.remove_permission('pygsheettest2@gmail.com')
assert len(old_per) == len(self.spreadsheet.permissions)
with pytest.raises(CannotRemoveOwnerError):
self.spreadsheet.remove_permission('', permission_id=self.spreadsheet.permissions[-1]['id'])
def test_developer_metadata(self):
old_meta = self.spreadsheet.get_developer_metadata()
meta_val = self.spreadsheet.create_developer_metadata("testkey", "testvalue")
assert meta_val.key == "testkey"
assert meta_val.value == "testvalue"
new_meta = self.spreadsheet.get_developer_metadata()
assert len(new_meta) == len(old_meta) + 1
meta_val.value = "newtestvalue"
meta_val.update()
updated_meta_val = self.spreadsheet.get_developer_metadata("testkey")[0]
assert updated_meta_val.key == "testkey"
assert updated_meta_val.value == "newtestvalue"
updated_meta_val.delete()
final_meta = self.spreadsheet.get_developer_metadata()
assert len(final_meta) == len(old_meta)
# @pytest.mark.skip()
class TestWorkSheet(object):
def setup_class(self):
title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
self.spreadsheet = pygsheet_client.create(title)
self.worksheet = self.spreadsheet.worksheet()
self.copy_sheet_title = test_config.get('CopySpreadsheet', 'title') + PYTHON_VERSION
self.output_path = test_config.get('Output', 'path').format(PYTHON_VERSION)
if not os.path.exists(self.output_path):
os.mkdir(self.output_path)
def teardown_class(self):
self.spreadsheet.delete()
for root, dirs, files in os.walk(self.output_path):
for file in files:
os.remove(root + file)
os.rmdir(self.output_path)
def test_properties(self):
json_sheet = self.worksheet.jsonSheet
assert self.worksheet.id == json_sheet['properties']['sheetId']
assert self.worksheet.title == json_sheet['properties']['title']
assert self.worksheet.index == json_sheet['properties']['index']
def test_resize(self):
rows = self.worksheet.rows
cols = self.worksheet.cols
self.worksheet.cols = cols + 1
assert self.worksheet.cols == cols + 1
self.worksheet.add_cols(1)
assert self.worksheet.cols == cols + 2
self.worksheet.rows = rows + 1
assert self.worksheet.rows == rows + 1
self.worksheet.add_rows(1)
assert self.worksheet.rows == rows + 2
self.worksheet.resize(rows, cols)
assert self.worksheet.cols == cols
assert self.worksheet.rows == rows
def test_frozen_rows(self):
ws = self.worksheet
assert ws.frozen_rows == 0
ws.frozen_rows = 1
ws.refresh()
assert ws.frozen_rows == 1
ws.frozen_rows = 0
ws.refresh()
def test_frozen_cols(self):
ws = self.worksheet
assert ws.frozen_cols == 0
ws.frozen_cols = 2
ws.refresh()
assert ws.frozen_cols == 2
ws.frozen_cols = 0
ws.refresh()
def test_addr_reformat(self):
addr = pygsheets.format_addr((1, 1))
assert addr == 'A1'
addr = pygsheets.format_addr('A1')
assert addr == (1, 1)
def test_cell(self):
assert isinstance(self.worksheet.cell('A1'), pygsheets.Cell)
assert isinstance(self.worksheet.cell((1, 1)), pygsheets.Cell)
with pytest.raises(pygsheets.CellNotFound):
self.worksheet.cell((self.worksheet.rows + 5, self.worksheet.cols + 5))
def test_insert_cols_rows(self):
cols = self.worksheet.cols
self.worksheet.insert_cols(1, 2)
assert self.worksheet.cols == (cols+2)
rows = self.worksheet.rows
self.worksheet.insert_rows(1, 2)
assert self.worksheet.rows == (rows + 2)
with pytest.raises(pygsheets.InvalidArgumentValue):
pygsheets.format_addr([1, 1])
def test_append_table(self):
# Test appending values to a blank spreadsheet
self.worksheet.clear()
rows = self.worksheet.rows
ret = self.worksheet.append_table([[1, 2, '3', 4, 'a little more'],
['5', 6, 'seven eight nine ten']])
assert isinstance(ret, dict)
assert isinstance(ret['updates']['updatedRange'], pygsheets.GridRange)
assert ret['updates']['updatedRange'].start == 'A1'
with pytest.raises(KeyError):
temp = ret['tableRange'] # tableRange should not be included
assert self.worksheet.rows == rows + 2
# Also test appending values to an existing range
rows = self.worksheet.rows
ret = self.worksheet.append_table(['A', 'B', 'C', 'D', 'tea'])
assert isinstance(ret, dict)
assert isinstance(ret['tableRange'], pygsheets.GridRange)
assert isinstance(ret['updates']['updatedRange'], pygsheets.GridRange)
assert ret['updates']['updatedRange'].start == 'A3'
assert self.worksheet.rows == rows + 1
# Test overwrite and columns options
rows = self.worksheet.rows
ret = self.worksheet.append_table(['bom', 'bom', 'bom'], dimension='COLUMNS', overwrite=True)
assert isinstance(ret, dict)
for addr in ['A4', 'A5', 'A6']: # columns option inserts 3 rows instead of 1 row with three values
assert self.worksheet.cell(addr).value == 'bom' # make sure they're there
assert self.worksheet.rows == rows # overwrite option should not add new rows
def test_values(self):
self.worksheet.update_value('A1', 'test val')
vals = self.worksheet.get_values('A1', 'B4')
assert isinstance(vals, list)
assert vals[0][0] == 'test val'
vals = self.worksheet.get_values('A1', (2, 2), 'cells')
assert isinstance(vals, list)
assert isinstance(vals[0][0], pygsheets.Cell)
assert vals[0][0].value == 'test val'
def test_update_cells(self):
self.worksheet.update_values(crange='A1:B2', values=[[1, 2], [3, 4]])
assert self.worksheet.cell((1, 1)).value == str(1)
self.worksheet.resize(1, 1)
self.worksheet.update_values(crange='A1', values=[[1, 2, 5], [3, 4, 6], [3, 4, 61]], extend=True)
assert self.worksheet.cols == 3
assert self.worksheet.rows == 3
assert self.worksheet.cell((3, 3)).value == '61'
self.worksheet.resize(30, 30)
cells = [pygsheets.Cell('A1', 10), pygsheets.Cell('A2', 12)]
self.worksheet.update_values(cell_list=cells)
assert self.worksheet.cell((1, 1)).value == str(cells[0].value)
def test_update_col(self):
self.worksheet.resize(30, 30)
self.worksheet.update_col(5, [1, 2, 3, 4, 5])
cols = self.worksheet.get_col(5)
assert isinstance(cols, list)
assert cols[3] == str(4)
def test_update_row(self):
self.worksheet.resize(30, 30)
self.worksheet.update_row(5, [1, 2, 3, 4, 5])
rows = self.worksheet.get_row(5)
assert isinstance(rows, list)
assert rows[3] == str(4)
def test_range(self):
assert isinstance(self.worksheet.range('A1:A5'), list)
def test_value_set(self):
self.worksheet.update_value('A1', 'xxx')
assert self.worksheet.cell('A1').value == 'xxx'
def test_iter(self):
self.worksheet.update_row(1, [1, 2, 3, 4, 5])
self.worksheet.update_row(2, [2, 3, 4, 5, 6])
wks_iter = iter(self.worksheet)
assert next(wks_iter)[:5] == ['1', '2', '3', '4', '5']
assert next(wks_iter)[:5] == ['2', '3', '4', '5', '6']
def test_getitem(self):
self.worksheet.update_row(1, [1, 2, 3, 4, 5])
row = self.worksheet[1]
assert len(row) == self.worksheet.cols
assert row[0] == str(1) # TODO first index is dummy
def test_clear(self):
self.worksheet.update_value('S10', 100)
self.worksheet.clear()
assert self.worksheet.get_all_values(include_tailing_empty=False, include_tailing_empty_rows=False) == [[]]
def test_delete_dimension(self):
self.worksheet.clear()
rows = self.worksheet.rows
self.worksheet.update_row(10, [1, 2, 3, 4, 5])
self.worksheet.delete_rows(10)
assert self.worksheet.get_value((9, 2)) != 2
assert self.worksheet.rows == rows - 1
cols = self.worksheet.cols
self.worksheet.update_col(10, [1, 2, 3, 4, 5])
self.worksheet.delete_cols(10)
assert self.worksheet.get_value((10, 2)) != 2
assert self.worksheet.cols == cols - 1
def test_copy_to(self):
target = pygsheet_client.create(self.copy_sheet_title)
spreadsheet_id = target.id
worksheet_copy = self.worksheet.copy_to(spreadsheet_id)
assert worksheet_copy.spreadsheet.id == spreadsheet_id
# @TODO
def test_append_row(self):
assert True
def test_set_dataframe(self):
try:
import pandas as pd
except ImportError:
pass
else:
df = pd.DataFrame({'a': [1, 2, 3, 'g'], 'x': [4, 5, 6, 'h']})
self.worksheet.set_dataframe(df, 'B2', copy_head=True, fit=True, copy_index=True)
assert self.worksheet.get_value('D5') == '6'
assert self.worksheet.get_value('C5') == '3'
assert self.worksheet.get_value('D2') == 'x'
assert self.worksheet.cols == 4
assert self.worksheet.rows == 6
self.worksheet.set_dataframe(df, 'B2', copy_head=True, fit=True, copy_index=False)
assert self.worksheet.get_value('C2') == 'x'
self.worksheet.set_dataframe(df, 'B2', copy_head=False, fit=True, copy_index=False)
assert self.worksheet.get_value('B2') == '1'
assert self.worksheet.get_value('C2') == '4'
# Test MultiIndex
try:
import numpy as np
except ImportError:
pass
else:
arrays = [np.array(['bar', 'bar', 'baz', 'baz', 'foo', 'foo', 'qux', 'qux']),
np.array(['one', 'two', 'one', 'two', 'one', 'two', 'one', 'two'])]
tuples = list(zip(*arrays))
index = pd.MultiIndex.from_tuples(tuples, names=['first', 'second'])
df = pd.DataFrame(np.random.randn(8, 8), index=index, columns=index)
self.worksheet.set_dataframe(df, 'A1', copy_index=True)
assert self.worksheet.get_value('C1') == 'bar'
assert self.worksheet.get_value('C2') == 'one'
assert self.worksheet.get_value('F1') == 'baz'
assert self.worksheet.get_value('F2') == 'two'
self.worksheet.clear()
# @TODO
def test_get_as_df(self):
assert True
def test_get_values(self):
self.worksheet.resize(10, 10)
self.worksheet.clear()
assert self.worksheet.get_values('A1', 'E5', include_tailing_empty=True, include_tailing_empty_rows=True)
self.worksheet.update_values('A1:D4', [[1, 2, '', 3], ['','','',''], [4, 5, '', ''], ['', 6, '', '']])
# matrix testing
assert self.worksheet.get_values('A1', 'E5', include_tailing_empty=True, include_tailing_empty_rows=True) == \
[[u'1', u'2', u'', u'3', ''], ['', '', '', '', ''], [u'4', u'5', '', '', ''], [u'', u'6', '', '', ''], ['', '', '', '', '']]
assert self.worksheet.get_values('A1', 'E5', include_tailing_empty=True, include_tailing_empty_rows=False) == \
[[u'1', u'2', u'', u'3', ''], ['', '', '', '', ''], [u'4', u'5', '', '', ''], [u'', u'6', '', '', ''] ]
assert self.worksheet.get_values('A1', 'E5', include_tailing_empty=False, include_tailing_empty_rows=True) == \
[[u'1', u'2', u'', u'3'], [], [u'4', u'5'], [u'', u'6'], []]
assert self.worksheet.get_values('A1', 'E5', include_tailing_empty=False, include_tailing_empty_rows=False) == \
[[u'1', u'2', u'', u'3'], [], [u'4', u'5'], [u'', u'6']]
# matrix testing columns
assert self.worksheet.get_values('A1', 'E5', include_tailing_empty=True, include_tailing_empty_rows=True, majdim="COLUMNS") == \
[[u'1', u'', u'4', '', ''],[u'2', u'', u'5', u'6', ''], ['', '', '', '', ''], [u'3', '', '', '', ''], ['', '', '', '', '']]
assert self.worksheet.get_values('A1', 'E5', include_tailing_empty=True, include_tailing_empty_rows=False, majdim="COLUMNS") == \
[[u'1', u'', u'4', '', ''],[u'2', u'', u'5', u'6', ''], ['', '', '', '', ''], [u'3', '', '', '', '']]
assert self.worksheet.get_values('A1', 'E5', include_tailing_empty=False, include_tailing_empty_rows=True, majdim="COLUMNS") == \
[[u'1', u'', u'4'], [u'2', u'', u'5', u'6'], [], [u'3'], []]
assert self.worksheet.get_values('A1', 'E5', include_tailing_empty=False, include_tailing_empty_rows=False, majdim="COLUMNS") == \
[[u'1', u'', u'4'], [u'2', u'', u'5', u'6'], [], [u'3']]
# # Cells testing rows #TODO enable , failing for some unknown reason
# self.worksheet.clear()
# self.worksheet.update_values('A1:B2', [[1, 2], [3,'']])
# assert self.worksheet.get_values('A1', 'C3', include_tailing_empty=True, include_tailing_empty_rows=True, returnas="cells") == \
# [[Cell('A1', '1'), Cell('B1', '2'), Cell('C1', '')],
# [Cell('A2', '3'), Cell('B2', ''), Cell('C2', '')],
# [Cell('A3', ''), Cell('B3', ''), Cell('C3', '')]]
# assert self.worksheet.get_values('A1', 'C3', include_tailing_empty=True, include_tailing_empty_rows=False, returnas="cells") == \
# [[Cell('A1', '1'), Cell('B1', '2'), Cell('C1', '')],
# [Cell('A2', '3'), Cell('B2', ''), Cell('C2', '')],
# [Cell('A3', ''), Cell('B3', ''), Cell('C3', '')]]
#
# assert self.worksheet.get_values('A1', 'C3', include_tailing_empty=False, include_tailing_empty_rows=True, returnas="cells") == \
# [[Cell('A1', '1'), Cell('B1', '2')], [Cell('A2', '3')], []]
# assert self.worksheet.get_values('A1', 'D3', include_tailing_empty=False, include_tailing_empty_rows=False, returnas="cells" ) == \
# [[Cell('A1', '1'), Cell('B1', '2')], [Cell('A2', '3')]]
#
# # Cells testing cols
# self.worksheet.clear()
# self.worksheet.update_values('A1:B2', [[1, 2], [3,'']])
# assert self.worksheet.get_values('A1', 'C3', include_tailing_empty=True, include_tailing_empty_rows=True,returnas="cells",majdim="COLUMNS") == \
# [[Cell('A1', '1'), Cell('A2', '2'), Cell('A3', '')],
# [Cell('B1', '3'), Cell('B2', ''), Cell('B3', '')],
# [Cell('C1', ''), Cell('C2', ''), Cell('C3', '')]]
# assert self.worksheet.get_values('A1', 'C3', include_tailing_empty=True, include_tailing_empty_rows=False,returnas="cells",majdim="COLUMNS") == \
# [[Cell('A1', '1'), Cell('A2', '2'), Cell('A3', '')],
# [Cell('B1', '3'), Cell('B2', ''), Cell('B3', '')]]
# assert self.worksheet.get_values('A1', 'C3', include_tailing_empty=False, include_tailing_empty_rows=True ,returnas="cells",majdim="COLUMNS") == \
# [[Cell('A1', '1'), Cell('A2', '2')], [Cell('B1', '3')], []]
# assert self.worksheet.get_values('A1', 'D3', include_tailing_empty=False, include_tailing_empty_rows=False,returnas="cells",majdim="COLUMNS") == \
# [[Cell('A1', '1'), Cell('A2', '2')], [Cell('B1', '3')]]
def test_hide_rows(self):
self.worksheet.hide_dimensions(1, 3, dimension="ROWS")
json = self.spreadsheet.client.sheet.get(self.spreadsheet.id, fields="sheets/data/rowMetadata/hiddenByUser")
assert json['sheets'][0]['data'][0]['rowMetadata'][0]['hiddenByUser'] == True
assert json['sheets'][0]['data'][0]['rowMetadata'][1]['hiddenByUser'] == True
self.worksheet.show_dimensions(1, 3,dimension="ROWS")
json = self.spreadsheet.client.sheet.get(self.spreadsheet.id, fields="sheets/data/rowMetadata/hiddenByUser")
assert json['sheets'][0]['data'][0]['rowMetadata'][0].get('hiddenByUser', False) == False
assert json['sheets'][0]['data'][0]['rowMetadata'][1].get('hiddenByUser', False) == False
def test_hide_columns(self):
self.worksheet.hide_dimensions(1, 3,dimension="COLUMNS")
json = self.spreadsheet.client.sheet.get(self.spreadsheet.id, fields="sheets/data/columnMetadata/hiddenByUser")
assert json['sheets'][0]['data'][0]['columnMetadata'][0]['hiddenByUser'] == True
assert json['sheets'][0]['data'][0]['columnMetadata'][1]['hiddenByUser'] == True
self.worksheet.show_dimensions(1, 3, dimension="COLUMNS")
json = self.spreadsheet.client.sheet.get(self.spreadsheet.id, fields="sheets/data/columnMetadata/hiddenByUser")
assert json['sheets'][0]['data'][0]['columnMetadata'][0].get('hiddenByUser', False) == False
assert json['sheets'][0]['data'][0]['columnMetadata'][1].get('hiddenByUser', False) == False
def test_find(self):
cells = self.worksheet.find('test')
assert isinstance(cells, list)
assert 0 == len(cells)
self.worksheet.clear()
self.worksheet.update_row(1, ['test', 'test', 100, 'TEST', 'testtest', 'test', 'test', '=SUM(C:C)'])
cells = self.worksheet.find('test')
assert 6 == len(cells)
cells = self.worksheet.find('Test')
assert 6 == len(cells)
cells = self.worksheet.find('TEST')
assert 6 == len(cells)
cells = self.worksheet.find('test', matchCase=True)
assert 5 == len(cells)
cells = self.worksheet.find('TEST', matchCase=True)
assert 1 == len(cells)
cells = self.worksheet.find('test', matchEntireCell=True)
assert 5 == len(cells)
cells = self.worksheet.find('test', matchCase=True, matchEntireCell=True)
assert 4 == len(cells)
cells = self.worksheet.find('test', searchByRegex=True, matchCase=True)
assert 5 == len(cells)
cells = self.worksheet.find('test', searchByRegex=True, matchEntireCell=True)
assert 5 == len(cells)
cells = self.worksheet.find('test', searchByRegex=True, matchCase=True, matchEntireCell=True)
assert 4 == len(cells)
cells = self.worksheet.find('100')
assert 1 == len(cells)
cells = self.worksheet.find('100', matchEntireCell=False, includeFormulas=True)
assert 2 == len(cells)
cells = self.worksheet.find('\w+', searchByRegex=True)
assert 7 == len(cells)
self.worksheet.clear('A1', 'H1')
def test_replace(self):
self.worksheet.update_row(1, ['test', 'test', 100, 'TEST', 'testtest', 'test', 'test', '=SUM(C:C)'])
self.worksheet.replace('test', 'value')
assert self.worksheet.cell('A1').value == 'value'
# TODO: Unlink does not work. This should test unlinked replace, as it is different from linked.
# but instead just tests normal again.
# self.worksheet.unlink()
# self.worksheet.replace('value', 'test')
# assert self.worksheet.cell('A1').value == 'test'
def test_export(self):
self.worksheet.update_row(1, ['test', 'test', 'test'])
self.worksheet.export(filename='test', path=self.output_path)
self.worksheet.export(file_format=ExportType.PDF, filename='test', path=self.output_path)
self.worksheet.export(file_format=ExportType.XLSX, filename='test', path=self.output_path)
self.worksheet.export(file_format=ExportType.ODS, filename='test', path=self.output_path)
self.worksheet.export(file_format=ExportType.HTML, filename='test', path=self.output_path)
self.worksheet.export(file_format=ExportType.TSV, filename='test', path=self.output_path)
assert os.path.exists(self.output_path + '/test.csv')
assert os.path.exists(self.output_path + '/test.tsv')
assert os.path.exists(self.output_path + '/test.xlsx')
assert os.path.exists(self.output_path + '/test.ods')
assert os.path.exists(self.output_path + '/test.zip')
self.spreadsheet.add_worksheet('test2')
worksheet_2 = self.spreadsheet.worksheet('title', 'test2')
worksheet_2.update_row(1, ['test', 'test', 'test', 'test', 'test'])
worksheet_2.export(file_format=ExportType.CSV, filename='test', path=self.output_path)
assert os.path.exists(self.output_path + '/test.csv')
with open(self.output_path + '/test.csv', 'r') as file:
content = file.read()
assert 'test,test,test,test,test' == content
self.worksheet.clear()
self.spreadsheet.del_worksheet(worksheet_2)
def test_sort_range(self):
self.worksheet.update_values('A1:A4',[[2],[3],[1],[4]])
self.worksheet.sort_range('A1','A4',0,'ASCENDING')
assert self.worksheet.get_values('A1','A4') == [['1'],['2'],['3'],['4']]
self.worksheet.sort_range('A1','A4',0,'DESCENDING')
assert self.worksheet.get_values('A1','A4') == [['4'],['3'],['2'],['1']]
def test_get_protected_range(self):
range = self.worksheet.range("A1:A2", returnas="range")
range.protected = True
ranges = self.worksheet.get_protected_ranges()
assert len(ranges) == 1
assert ranges[0].protect_id == range.protect_id
range.protected = False
def test_delete_protected_range(self):
range = self.worksheet.range("A1:A2", returnas="range")
range.protected = True
ranges = self.worksheet.get_protected_ranges()
assert len(ranges) == 1
range.protected = False
ranges = self.worksheet.get_protected_ranges()
assert len(ranges) == 0
def test_add_chart(self):
self.worksheet.resize(50,50)
self.worksheet.update_values('A10:C13',[['x','y','z'],[1,5,9],[2,4,8],[3,6,10]])
dmn = [(10,1),(13,1)]
rng = [[(10,2),(13,2)],[(10,3),(13,3)]]
obj = self.worksheet.add_chart(dmn, rng, "Test5", pygsheets.ChartType.COLUMN, "A16")
assert obj.title == "Test5"
assert obj.chart_type == pygsheets.ChartType.COLUMN
assert obj.domain == dmn
assert obj.ranges == rng
assert obj.font_name == "Roboto"
assert obj.title_font_family == "Roboto"
obj.delete()
self.worksheet.clear()
def test_add_pie_chart(self):
self.worksheet.resize(50,50)
self.worksheet.update_values('A10:C13', [['x', 'y', 'z'], [1, 5, 9]])
dmn = [(10, 1), (13, 1)]
rng = [(10, 2), (13, 2)]
obj = self.worksheet.add_pie_chart(dmn, rng, "Test Pie Chart", "A16")
assert obj.title == "Test Pie Chart"
assert obj.domain == dmn
assert obj.ranges[0] == rng
assert obj._three_dimensional is False
assert obj._pie_hole == 0
assert obj.font_name == "Roboto"
assert obj.title_font_family == "Roboto"
obj.delete()
self.worksheet.clear()
def test_add_pie_chart_three_dimensional(self):
self.worksheet.resize(50,50)
self.worksheet.update_values('A10:C13', [['x', 'y', 'z'], [1, 5, 9]])
dmn = [(10, 1), (13, 1)]
rng = [(10, 2), (13, 2)]
obj = self.worksheet.add_pie_chart(dmn, rng, "Test Pie Chart", "A16", three_dimensional=True)
assert obj.title == "Test Pie Chart"
assert obj.domain == dmn
assert obj.ranges[0] == rng
assert obj._three_dimensional is True
assert obj._pie_hole == 0
assert obj.font_name == "Roboto"
assert obj.title_font_family == "Roboto"
obj.delete()
self.worksheet.clear()
def test_add_pie_chart_pie_hole(self):
self.worksheet.resize(50,50)
self.worksheet.update_values('A10:C13', [['x', 'y', 'z'], [1, 5, 9]])
dmn = [(10, 1), (13, 1)]
rng = [(10, 2), (13, 2)]
obj = self.worksheet.add_pie_chart(dmn, rng, "Test Pie Chart", "A16", pie_hole=0.5)
assert obj.title == "Test Pie Chart"
assert obj.domain == dmn
assert obj.ranges[0] == rng
assert obj._three_dimensional is False
assert obj._pie_hole == 0.5
assert obj.font_name == "Roboto"
assert obj.title_font_family == "Roboto"
obj.delete()
self.worksheet.clear()
def test_add_pie_chart_invalid_pie_hole(self):
self.worksheet.resize(50,50)
self.worksheet.update_values('A10:C13', [['x', 'y', 'z'], [1, 5, 9]])
dmn = [(10, 1), (13, 1)]
rng = [(10, 2), (13, 2)]
with pytest.raises(ValueError):
obj = self.worksheet.add_pie_chart(dmn, rng, "Test Pie Chart", "A16", pie_hole=2)
self.worksheet.clear()
def test_get_charts(self):
self.worksheet.resize(50,50)
self.worksheet.update_values('A30:C33',[['x','y','z'],[1,5,9],[2,4,8],[3,6,10]])
dmn = [(30,1),(33,1)]
rng = [[(30,2),(33,2)],[(30,3),(33,3)]]
obj = self.worksheet.add_chart(dmn, rng, "Test2", pygsheets.ChartType.COLUMN, "A16")
obj2 = self.worksheet.get_charts("Test2")
obj2[0].title = "Test_changed"
obj2[0].chart_type = pygsheets.ChartType.BAR
obj2[0].anchor_cell = (12,7)
obj2[0].ranges = [[(30,2),(33,2)]]
obj2[0].legend_position = "LEFT_LEGEND"
obj.refresh()
assert obj.legend_position == "LEFT_LEGEND"
assert obj.title == "Test_changed"
assert obj.chart_type == pygsheets.ChartType.BAR
assert obj.anchor_cell == (12,7)
assert obj.ranges == [[(30,2),(33,2)]]
obj.delete()
self.worksheet.clear()
def test_set_basic_filter(self):
self.worksheet.resize(50, 50)
self.worksheet.update_values('A1:C5', [
['col1', 'col2', 'col3'],
['444', '222', '666'],
['111', '888', '333'],
['111', '555', '999'],
['=TODAY()+1', '555', '999']
]
)
test_cases = [
{
'input': {
'start_addr': 'A1',
'end_addr': 'C5'
},
'expect': {
'basicFilter': {
'range': {
'startRowIndex': 0,
'endRowIndex': 5,
'startColumnIndex': 0,
'endColumnIndex': 3
}
},
'first_val': '444'
}
},
{
'input': {
'grange': pygsheets.address.GridRange(
worksheet=self.worksheet,
start='A1',
end='C5'
)
},
'expect': {
'basicFilter': {
'range': {
'startRowIndex': 0,
'endRowIndex': 5,
'startColumnIndex': 0,
'endColumnIndex': 3
}
},
'first_val': '444'
}
},
{
'input': {
'start_addr': 'A1',
'end_addr': 'C5',
'grange': pygsheets.address.GridRange(
worksheet=self.worksheet,
start='A1',
end='C5'
)
},
'expect': {
'basicFilter': {
'range': {
'startRowIndex': 0,
'endRowIndex': 5,
'startColumnIndex': 0,
'endColumnIndex': 3
}
},
'first_val': '444'
}
},
{
'input': {
'start_addr': 'A1',
},
'expect': {
'basicFilter': {
'range': {
'startRowIndex': 0,
'endRowIndex': 50,
'startColumnIndex': 0,
'endColumnIndex': 50
}
},
'first_val': '444'
}
},
{
'input': {
'end_addr': 'C5'
},
'expect': {
'basicFilter': {
'range': {
'startRowIndex': 0,
'endRowIndex': 5,
'startColumnIndex': 0,
'endColumnIndex': 3
}
},
'first_val': '444'
}
},
{
'input': {
'start_addr': 'A1',
'end_addr': 'C5',
'sort_order': 'ASCENDING',
'sort_column_index': 0,
},
'expect': {
'basicFilter': {
'range': {
'startRowIndex': 0,
'endRowIndex': 5,
'startColumnIndex': 0,
'endColumnIndex': 3
},
'sortSpecs': [{
'dimensionIndex': 0,
'sortOrder': 'ASCENDING'
}]
},
'first_val': '111'
}
},
{
'input': {
'start_addr': 'A1',
'end_addr': 'C5',
'filter_column_index': 0,
'hidden_values': ['111']
},
'expect': {
'basicFilter': {
'range': {
'startRowIndex': 0,
'endRowIndex': 5,
'startColumnIndex': 0,
'endColumnIndex': 3
},
'criteria': {
'0': {
'hiddenValues': ['111']
}
},
'filterSpecs': [
{
'columnIndex': 0,
'filterCriteria': {
'hiddenValues': ['111']
}
}]
},
'first_val': '111'
}
},
{
'input': {
'start_addr': 'A1',
'end_addr': 'C5',
'filter_column_index': 0,
'condition_type': 'TEXT_EQ',
'condition_values': ['111']
},
'expect': {
'basicFilter': {
'range': {
'startRowIndex': 0,
'endRowIndex': 5,
'startColumnIndex': 0,
'endColumnIndex': 3
},
'criteria': {
'0': {
'condition': {
'type': 'TEXT_EQ',
'values': [
{
'userEnteredValue': '111'
}
]
}
}
},
'filterSpecs': [
{
'columnIndex': 0,
'filterCriteria': {
'condition': {
'type': 'TEXT_EQ',
'values': [
{
'userEnteredValue': '111'
}
]
}
}
}]
},
'first_val': '111'
}
},
{
'input': {
'start_addr': 'A1',
'end_addr': 'C5',
'filter_column_index': 0,
'condition_type': 'DATE_AFTER',
'condition_values': ['TODAY']
},
'expect': {
'basicFilter': {
'range': {
'startRowIndex': 0,
'endRowIndex': 5,
'startColumnIndex': 0,
'endColumnIndex': 3
},
'criteria': {
'0': {
'condition': {
'type': 'DATE_AFTER',
'values': [
{
'relativeDate': 'TODAY'
}
]
}
}
},
'filterSpecs': [
{
'columnIndex': 0,
'filterCriteria': {
'condition': {
'type': 'DATE_AFTER',
'values': [
{
'relativeDate': 'TODAY'
}
]
}
}
}]
},
'first_val': '111'
}
}
]
for case in test_cases:
self.worksheet.set_basic_filter(
start=case['input'].get('start_addr'),
end=case['input'].get('end_addr'),
grange=case['input'].get('grange'),
sort_order=case['input'].get('sort_order'),
sort_column_index=case['input'].get('sort_column_index'),
filter_column_index=case['input'].get('filter_column_index'),
hidden_values=case['input'].get('hidden_values'),
condition_type=case['input'].get('condition_type'),
condition_values=case['input'].get('condition_values')
)
params = {
'spreadsheet_id': self.worksheet.spreadsheet.id,
'fields': 'sheets(properties(sheetId,title),basicFilter)'
}
res = self.worksheet.client.sheet.get(**params)
first_val = self.worksheet.get_value('A2')
assert res['sheets'][0]['basicFilter'] == case['expect']['basicFilter']
assert first_val == case['expect']['first_val'] # for the test whether the value is sorted or not.
def test_clear_basic_filter(self):
# initialize
self.worksheet.resize(50, 50)
self.worksheet.update_values('A1:C3', [
['col1', 'col2', 'col3'],
['444', '222', '666'],
['111', '888', '333']
]
)
self.worksheet.set_basic_filter(start='A1', end='C3')
params = {
'spreadsheet_id': self.worksheet.spreadsheet.id,
'fields': 'sheets(properties(sheetId,title),basicFilter)'
}
# test whether filter exists or not
input = 'basicFilter' in self.worksheet.client.sheet.get(**params)['sheets'][0]
assert input == True
# test whether filter is cleared or not
self.worksheet.clear_basic_filter()
input = 'basicFilter' in self.worksheet.client.sheet.get(**params)['sheets'][0]
assert input == False
# test whether request for the spreadsheet which has no filter doesn't return error or not.
self.worksheet.clear_basic_filter()
input = 'basicFilter' in self.worksheet.client.sheet.get(**params)['sheets'][0]
assert input == False
def test_developer_metadata(self):
old_meta = self.worksheet.get_developer_metadata()
meta_val = self.worksheet.create_developer_metadata("testkey", "testvalue")
assert meta_val.key == "testkey"
assert meta_val.value == "testvalue"
new_meta = self.worksheet.get_developer_metadata()
assert len(new_meta) == len(old_meta) + 1
meta_val.value = "newtestvalue"
meta_val.update()
updated_meta_val = self.worksheet.get_developer_metadata("testkey")[0]
assert updated_meta_val.key == "testkey"
assert updated_meta_val.value == "newtestvalue"
updated_meta_val.delete()
final_meta = self.worksheet.get_developer_metadata()
assert len(final_meta) == len(old_meta)
# @pytest.mark.skip()
class TestDataRange(object):
def setup_class(self):
title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
self.spreadsheet = pygsheet_client.create(title)
self.worksheet = self.spreadsheet.worksheet()
self.range = self.worksheet.range("A1:A2", returnas="range")
def teardown_class(self):
self.spreadsheet.delete()
def test_protected_range(self):
self.range.protected = True
assert self.range.protected
assert self.range.protect_id is not None
assert self.range is not None
assert len(self.spreadsheet.protected_ranges) == 1
self.range.protected = False
assert not self.range.protected
assert self.range.protect_id is None
assert len(self.spreadsheet.protected_ranges) == 0
# @pytest.mark.skip()
class TestCell(object):
def setup_class(self):
title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
self.spreadsheet = pygsheet_client.create(title)
self.worksheet = self.spreadsheet.worksheet()
self.cell = self.worksheet.cell('A1')
self.cell.value = 'test_value'
def teardown_class(self):
self.spreadsheet.delete()
def test_properties(self):
assert self.cell.row == 1
assert self.cell.col == 1
assert self.cell.value == 'test_value'
assert self.cell.label == 'A1'
def test_alignment(self):
self.cell.horizontal_alignment = HorizontalAlignment.RIGHT
self.cell.vertical_alignment = VerticalAlignment.MIDDLE
assert self.cell.horizontal_alignment == HorizontalAlignment.RIGHT
assert self.cell.vertical_alignment == VerticalAlignment.MIDDLE
def test_link(self):
self.worksheet.update_value('B2', 'new_val')
self.cell.row += 1
self.cell.col += 1
assert self.cell.row == 2
assert self.cell.col == 2
assert self.cell.value == 'new_val'
assert self.cell.label == 'B2'
self.worksheet.clear(start='B2', end='B2')
self.cell.row -= 1
self.cell.col -= 1
def test_formula(self):
self.worksheet.update_value('B1', 3)
self.worksheet.update_value('C1', 4)
cell = self.worksheet.cell('A1')
cell.formula = '=B1+C1'
assert cell.value == '7'
assert cell.value_unformatted == 7
def test_neighbour(self):
self.worksheet.update_value('B1', 7)
self.worksheet.update_value('C1', 8)
cell = self.worksheet.cell('A1')
assert cell.neighbour('right').value == '7'
assert cell.neighbour((0, 1)).value == '7'
assert cell.neighbour((0, 2)).value == '8'
def test_link_unlink(self):
self.worksheet.update_value('A1', 5)
cell = self.worksheet.cell('A1')
cell.unlink()
cell.value = 10
assert self.worksheet.get_value('A1') == '5'
cell.link(update=True)
assert self.worksheet.get_value('A1') == '10'
cell.unlink()
cell.value = 20
assert self.worksheet.get_value('A1') == '10'
cell.link()
cell.update()
assert self.worksheet.get_value('A1') == '20'
def test_wrap_strategy(self):
cell = self.worksheet.get_values('A1', 'A1', returnas="range")[0][0]
assert cell.wrap_strategy == "WRAP_STRATEGY_UNSPECIFIED"
cell.wrap_strategy = "WRAP"
cell = self.worksheet.get_values('A1', 'A1', returnas="range")[0][0]
assert cell.wrap_strategy == "WRAP"
cell.wrap_strategy = None
# @pytest.mark.skip()
class TestGridRange(object):
def setup_class(self):
title = test_config.get('Spreadsheet', 'title') + PYTHON_VERSION
self.spreadsheet = pygsheet_client.create(title)
self.worksheet = self.spreadsheet.worksheet()
self.grange = pygsheets.GridRange(worksheet=self.worksheet, start='A1', end='D4')
def teardown_class(self):
self.spreadsheet.delete()
def test_start_b_end_b(self):
self.grange.start = 'A2'
self.grange.end = 'D5'
assert self.grange.start == pygsheets.Address('A2')
assert self.grange.end == pygsheets.Address('D5')
assert self.grange.label == "'" + self.worksheet.title + "'" + '!' + 'A2' + ':' + 'D5'
def test_start_b_end_ub(self):
self.grange.start = 'A2'
self.grange.end = None
end_addr = pygsheets.Address((self.worksheet.rows, self.worksheet.cols))
assert self.grange.start == pygsheets.Address('A2')
assert self.grange.end == end_addr
assert self.grange.label == "'" + self.worksheet.title + "'" + '!' + 'A2' + ':' + end_addr.label
def test_start_ub_end_b(self):
self.grange.start = None
self.grange.end = 'D4'
assert self.grange.start == pygsheets.Address('A1')
assert self.grange.end == pygsheets.Address('D4')
assert self.grange.label == "'" + self.worksheet.title + "'" + '!' + 'A1' + ':' + 'D4'
def test_start_ub_end_ub(self):
self.grange.start = None
self.grange.end = None
assert not self.grange.start
assert not self.grange.end
assert self.grange.label == "'" + self.worksheet.title + "'"
def test_start_end_ub(self):
self.grange.start = 'A1'
self.grange.end = 'D'
assert self.grange.start == pygsheets.Address('A', True)
assert self.grange.end == pygsheets.Address('D', True)
assert self.grange.label == "'" + self.worksheet.title + "'" + '!' + 'A' + ':' + 'D'
def test_start_ub_end(self):
self.grange.indexes = ('A1', 'B2')
self.grange.start = '1'
self.grange.end = 'D4'
assert self.grange.start == pygsheets.Address('1', True)
assert self.grange.end == pygsheets.Address('4', True)
assert self.grange.label == "'" + self.worksheet.title + "'" + '!' + '1' + ':' + '4'
class TestUtils(object):
def test_is_number(self):
assert utils.is_number("1")
assert utils.is_number("-1")
assert utils.is_number("1.234")
assert utils.is_number("-1.234324")
assert utils.is_number("+1.345")
assert not utils.is_number("yuy")
assert not utils.is_number("12yuy34")
assert not utils.is_number("12.3.4")
assert not utils.is_number("12?34")
assert not utils.is_number("1.345_34")
def test_get_color_style(self):
test_cases = [
{
'input': (0,1,0,1),
'expect': {
'rgbColor': {
'red': 0,
'green': 1,
'blue': 0,
'alpha': 1
}
}
},
{
'input': 'TEXT',
'expect': {
'themeColor': 'TEXT'
},
},
{
'input': {'test': 'invalid'},
'expect': None,
},
{
'input': None,
'expect': None,
}
]
for case in test_cases:
res = utils.get_color_style(case['input'])
assert res == case['expect']
def test_get_boolean_condition(self):
test_cases = [
{
'input': {
'type': 'TEXT_EQ',
'values': ['111']
},
'expect': {
'type': 'TEXT_EQ',
'values': [{
'userEnteredValue': '111'
}]
}
},
{
'input': {
'type': 'DATE_AFTER',
'values': ['TODAY']
},
'expect': {
'type': 'DATE_AFTER',
'values': [{
'relativeDate': 'TODAY'
}]
}
},
{
'input': {
'type': None,
'values': None
},
'expect': None
}
]
for case in test_cases:
res = utils.get_boolean_condition(
type=case['input'].get('type'),
values=case['input'].get('values')
)
assert res == case['expect']