8000 Merge branch 'development' into 1301-fix-duplicate-permission-requests · daxcurson/server-client-python@95755be · GitHub
[go: up one dir, main page]
Skip to content

Commit 95755be

Browse files
jacalatajacalata
authored
Merge branch 'development' into 1301-fix-duplicate-permission-requests
2 parents 3fefcfa + 52d7f7c commit 95755be

25 files changed

+402
-106
lines changed

‎.github/workflows/code-coverage.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ jobs:
3333
run: pytest --junitxml=pytest.xml --cov=tableauserverclient test/ | tee pytest-coverage.txt
3434

3535
- name: Comment on pull request with coverage
36+
continue-on-error: true
3637
uses: MishaKav/pytest-coverage-comment@main
3738
with:
3839
pytest-coverage-path: ./pytest-coverage.txt

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ var/
2424
*.egg-info/
2525
.installed.cfg
2626
*.egg
27+
pip-wheel-metadata/
2728

2829
# PyInstaller
2930
# Usually these files are written by a python script from a template
@@ -89,6 +90,7 @@ env.py
8990
# virtualenv
9091
venv/
9192
ENV/
93+
.venv/
9294

9395
# Spyder project settings
9496
.spyderproject

‎pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ dependencies = [
1515
'defusedxml>=0.7.1', # latest as at 7/31/23
1616
'packaging>=23.1', # latest as at 7/31/23
1717
'requests>=2.31', # latest as at 7/31/23
18-
'urllib3==2.0.6', # latest as at 7/31/23
18+
'urllib3==2.0.7', # latest as at 7/31/23
1919
]
2020
requires-python = ">=3.7"
2121
classifiers = [

‎tableauserverclient/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# For when a datasource is over 64MB, break it into 5MB(standard chunk size) chunks
88
CHUNK_SIZE_MB = 5 * 10 # 5MB felt too slow, upped it to 50
99

10-
DELAY_SLEEP_SECONDS = 10
10+
DELAY_SLEEP_SECONDS = 0.1
1111

1212
# The maximum size of a file that can be published in a single request is 64MB
1313
FILESIZE_LIMIT_MB = 64

‎tableauserverclient/helpers/headers.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
from copy import deepcopy
2+
from urllib.parse import unquote_plus
3+
4+
5+
def fix_filename(params):
6+
if "filename*" not in params:
7+
return params
8+
9+
params = deepcopy(params)
10+
filename = params["filename*"]
11+
prefix = "UTF-8''"
12+
if filename.startswith(prefix):
13+
filename = filename[len(prefix) :]
14+
15+
params["filename"] = unquote_plus(filename)
16+
del params["filename*"]
17+
return params

‎tableauserverclient/helpers/strings.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
T = TypeVar("T", str, bytes)
1010

1111

12-
# usage: _redact_any_type("<xml workbook password= cooliothesecond>")
13-
# -> b"<xml workbook password =***************">
1412
def _redact_any_type(xml: T, sensitive_word: T, replacement: T, encoding=None) -> T:
1513
try:
1614
root = fromstring(xml)

‎tableauserverclient/models/interval_item.py

Lines changed: 95 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,12 @@ class HourlyInterval(object):
2929
def __init__(self, start_time, end_time, interval_value):
3030
self.start_time = start_time
3131
self.end_time = end_time
32-
self.interval = interval_value
32+
33+
# interval should be a tuple, if it is not, assign as a tuple with single value
34+
if isinstance(interval_value, tuple):
35+
self.interval = interval_value
36+
else:
37+
self.interval = (interval_value,)
3338

3439
def __repr__(self):
3540
return f"<{self.__class__.__name__} start={self.start_time} end={self.end_time} interval={self.interval}>"
@@ -63,25 +68,44 @@ def interval(self):
6368
return self._interval
6469

6570
@interval.setter
66-
def interval(self, interval):
71+
def interval(self, intervals):
6772
VALID_INTERVALS = {0.25, 0.5, 1, 2, 4, 6, 8, 12}
68-
if float(interval) not in VALID_INTERVALS:
69-
error = "Invalid interval {} not in {}".format(interval, str(VALID_INTERVALS))
70-
raise ValueError(error)
73+
for interval in intervals:
74+
# if an hourly interval is a string, then it is a weekDay interval
75+
if isinstance(interval, str) and not interval.isnumeric() and not hasattr(IntervalItem.Day, interval):
76+
error = "Invalid weekDay interval {}".format(interval)
77+
raise ValueError(error)
78+
79+
# if an hourly interval is a number, it is an hours or minutes interval
80+
if isinstance(interval, (int, float)) and float(interval) not in VALID_INTERVALS:
81+
error = "Invalid interval {} not in {}".format(interval, str(VALID_INTERVALS))
82+
raise ValueError(error)
7183

72-
self._interval = interval
84+
self._interval = intervals
7385

7486
def _interval_type_pairs(self):
75-
# We use fractional hours for the two minute-based intervals.
76-
# Need to convert to minutes from hours here
77-
if self.interval in {0.25, 0.5}:
78-
calculated_interval = int(self.interval * 60)
79-
interval_type = IntervalItem.Occurrence.Minutes
80-
else:
81-
calculated_interval = self.interval
82-
interval_type = IntervalItem.Occurrence.Hours
87+
interval_type_pairs = []
88+
for interval in self.interval:
89+
# We use fractional hours for the two minute-based intervals.
90+
# Need to convert to minutes from hours here
91+
if interval in {0.25, 0.5}:
92+
calculated_interval = int(interval * 60)
93+
interval_type = IntervalItem.Occurrence.Minutes
94+
95+
interval_type_pairs.append((interval_type, str(calculated_interval)))
96+
else:
97+
# if the interval is a non-numeric string, it will always be a weekDay
98+
if isinstance(interval, str) and not interval.isnumeric():
99+
interval_type = IntervalItem.Occurrence.WeekDay
100+
101+
interval_type_pairs.append((interval_type, str(interval)))
102+
# otherwise the interval is hours
103+
else:
104+
interval_type = IntervalItem.Occurrence.Hours
83105

84-
return [(interval_type, str(calculated_interval))]
106+
interval_type_pairs.append((interval_type, str(interval)))
107+
108+
return interval_type_pairs
85109

86110

87111
class DailyInterval(object):
@@ -111,8 +135,45 @@ def interval(self):
111135
return self._interval
112136

113137
@interval.setter
114-
def interval(self, interval):
115-
self._interval = interval
138+
def interval(self, intervals):
139+
VALID_INTERVALS = {0.25, 0.5, 1, 2, 4, 6, 8, 12}
140+
141+
for interval in intervals:
142+
# if an hourly interval is a string, then it is a weekDay interval
143+
if isinstance(interval, str) and not interval.isnumeric() and not hasattr(IntervalItem.Day, interval):
144+
error = "Invalid weekDay interval {}".format(interval)
145+
raise ValueError(error)
146+
147+
# if an hourly interval is a number, it is an hours or minutes interval
148+
if isinstance(interval, (int, float)) and float(interval) not in VALID_INTERVALS:
149+
error = "Invalid interval {} not in {}".format(interval, str(VALID_INTERVALS))
150+
raise ValueError(error)
151+
152+
self._interval = intervals
153+
154+
def _interval_type_pairs(self):
155+
interval_type_pairs = []
156+
for interval in self.interval:
157+
# We use fractional hours for the two minute-based intervals.
158+
# Need to convert to minutes from hours here
159+
if interval in {0.25, 0.5}:
160+
calculated_interval = int(interval * 60)
161+
interval_type = IntervalItem.Occurrence.Minutes
162+
163+
interval_type_pairs.append((interval_type, str(calculated_interval)))
164+
else:
165+
# if the interval is a non-numeric string, it will always be a weekDay
166+
if isinstance(interval, str) and not interval.isnumeric():
167+
interval_type = IntervalItem.Occurrence.WeekDay
168+
169+
interval_type_pairs.append((interval_type, str(interval)))
170+
# otherwise the interval is hours
171+
else:
172+
interval_type = IntervalItem.Occurrence.Hours
173+
174+
interval_type_pairs.append((interval_type, str(interval)))
175+
176+
return interval_type_pairs
116177

117178

118179
class WeeklyInterval(object):
@@ -155,7 +216,12 @@ def _interval_type_pairs(self):
155216
class MonthlyInterval(object):
156217
def __init__(self, start_time, interval_value):
157218
self.start_time = start_time
158-
self.interval = str(interval_value)
219+
220+
# interval should be a tuple, if it is not, assign as a tuple with single value
221+
if isinstance(interval_value, tuple):
222+
self.interval = interval_value
223+
else:
224+
self.interval = (interval_value,)
159225

160226
def __repr__(self):
161227
return f"<{self.__class__.__name__} start={self.start_time} interval={self.interval}>"
@@ -179,24 +245,24 @@ def interval(self):
179245
return self._interval
180246

181247
@interval.setter
182-
def interval(self, interval_value):
183-
error = "Invalid interval value for a monthly frequency: {}.".format(interval_value)
184-
248+
def interval(self, interval_values):
185249
# This is weird because the value could be a str or an int
186250
# The only valid str is 'LastDay' so we check that first. If that's not it
187251
# try to convert it to an int, if that fails because it's an incorrect string
188252
# like 'badstring' we catch and re-raise. Otherwise we convert to int and check
189253
# that it's in range 1-31
254+
for interval_value in interval_values:
255+
error = "Invalid interval value for a monthly frequency: {}.".format(interval_value)
190256

191-
if interval_value != "LastDay":
192-
try:
193-
if not (1 <= int(interval_value) <= 31):
194-
raise ValueError(error)
195-
except ValueError:
196-
if interval_value != "LastDay":
197-
raise ValueError(error)
257+
if interval_value != "LastDay":
258+
D7AE try:
259+
if not (1 <= int(interval_value) <= 31):
260+
raise ValueError(error)
261+
except ValueError:
262+
if interval_value != "LastDay":
263+
raise ValueError(error)
198264

199-
self._interval = str(interval_value)
265+
self._interval = interval_values
200266

201267
def _interval_type_pairs(self):
202268
return [(IntervalItem.Occurrence.MonthDay, self.interval)]

‎tableauserverclient/models/schedule_item.py

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -254,25 +254,43 @@ def _parse_interval_item(parsed_response, frequency, ns):
254254
interval.extend(interval_elem.attrib.items())
255255

256256
if frequency == IntervalItem.Frequency.Daily:
257-
return DailyInterval(start_time)
257+
converted_intervals = []
258+
259+
for i in interval:
260+
# We use fractional hours for the two minute-based intervals.
261+
# Need to convert to hours from minutes here
262+
if i[0] == IntervalItem.Occurrence.Minutes:
263+
converted_intervals.append(float(i[1]) / 60)
264+
elif i[0] == IntervalItem.Occurrence.Hours:
265+
converted_intervals.append(float(i[1]))
266+
else:
267+
converted_intervals.append(i[1])
268+
269+
return DailyInterval(start_time, *converted_intervals)
258270

259271
if frequency == IntervalItem.Frequency.Hourly:
260-
interval_occurrence, interval_value = interval.pop()
272+
converted_intervals = []
261273

262-
# We use fractional hours for the two minute-based intervals.
263-
# Need to convert to hours from minutes here
264-
if interval_occurrence == IntervalItem.Occurrence.Minutes:
265-
interval_value = float(interval_value) / 60
274+
for i in interval:
275+
# We use fractional hours for the two minute-based intervals.
276+
# Need to convert to hours from minutes here
277+
if i[0] == IntervalItem.Occurrence.Minutes:
278+
converted_intervals.append(float(i[1]) / 60)
279+
elif i[0] == IntervalItem.Occurrence.Hours:
280+
converted_intervals.append(i[1])
281+
else:
282+
converted_intervals.append(i[1])
266283

267-
return HourlyInterval(start_time, end_time, interval_value)
284+
return HourlyInterval(start_time, end_time, tuple(converted_intervals))
268285

269286
if frequency == IntervalItem.Frequency.Weekly:
270287
interval_values = [i[1] for i in interval]
271288
return WeeklyInterval(start_time, *interval_values)
272289

273290
if frequency == IntervalItem.Frequency.Monthly:
274-
interval_occurrence, interval_value = interval.pop()
275-
return MonthlyInterval(start_time, interval_value)
291+
interval_values = [i[1] for i in interval]
292+
293+
return MonthlyInterval(start_time, tuple(interval_values))
276294

277295
@staticmethod
278296
def _parse_element(schedule_xml, ns):

‎tableauserverclient/models/task_item.py

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1+
from datetime import datetime
2+
from typing import List, Optional
3+
14
from defusedxml.ElementTree import fromstring
25

36
from tableauserverclient.datetime_helpers import parse_datetime
4-
from .schedule_item import ScheduleItem
5-
from .target import Target
7+
from tableauserverclient.models.schedule_item import ScheduleItem
8+
from tableauserverclient.models.target import Target
69

710

811
class TaskItem(object):
@@ -19,14 +22,14 @@ class Type:
1922

2023
def __init__(
2124
self,
22-
id_,
23-
task_type,
24-
priority,
25-
consecutive_failed_count=0,
26-
schedule_id=None,
27-
schedule_item=None,
28-
last_run_at=None,
29-
target=None,
25+
id_: str,
26+
task_type: str,
27+
priority: int,
28+
consecutive_failed_count: int = 0,
29+
schedule_id: Optional[str] = None,
30+
schedule_item: Optional[ScheduleItem] = None,
31+
last_run_at: Optional[datetime] = None,
32+
target: Optional[Target] = None,
3033
):
3134
self.id = id_
3235
self.task_type = task_type
@@ -37,14 +40,14 @@ def __init__(
3740
self.last_run_at = last_run_at
3841
self.target = target
3942

40-
def __repr__(self):
43+
def __repr__(self) -> str:
4144
return (
4245
"<Task#{id} {task_type} pri({priority}) failed({consecutive_failed_count}) schedule_id({"
4346
"schedule_id}) target({target})>".format(**self.__dict__)
4447
)
4548

4649
@classmethod
47-
def from_response(cls, xml, ns, task_type=Type.ExtractRefresh):
50+
def from_response(cls, xml, ns, task_type=Type.ExtractRefresh) -> List["TaskItem"]:
4851
parsed_response = fromstring(xml)
4952
all_tasks_xml = parsed_response.findall(".//t:task/t:{}".format(task_type), namespaces=ns)
5053

@@ -62,8 +65,7 @@ def _parse_element(cls, element, ns):
6265
last_run_at_element = element.find(".//t:lastRunAt", namespaces=ns)
6366

6467
schedule_item_list = ScheduleItem.from_element(element, ns)
65-
if len(schedule_item_list) >= 1:
66-
schedule_item = schedule_item_list[0]
68+
schedule_item = next(iter(schedule_item_list), None)
6769

6870
# according to the Tableau Server REST API documentation,
6971
# there should be only one of workbook or datasource
@@ -87,14 +89,14 @@ def _parse_element(cls, element, ns):
8789
task_type,
8890
priority,
8991
consecutive_failed_count,
90-
schedule_item.id,
92+
schedule_item.id if schedule_item is not None else None,
9193
schedule_item,
9294
last_run_at,
9395
target,
9496
)
9597

9698
@staticmethod
97-
def _translate_task_type(task_type):
99+
def _translate_task_type(task_type: str) -> str:
98100
if task_type in TaskItem._TASK_TYPE_MAPPING:
99101
return TaskItem._TASK_TYPE_MAPPING[task_type]
100102
else:

‎tableauserverclient/server/endpoint/datasources_endpoint.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
from pathlib import Path
99
from typing import List, Mapping, Optional, Sequence, Tuple, TYPE_CHECKING, Union
1010

11+
from tableauserverclient.helpers.headers import fix_filename
12+
1113
if TYPE_CHECKING:
1214
from tableauserverclient.server import Server
1315
from tableauserverclient.models import PermissionsRule
@@ -441,6 +443,7 @@ def download_revision(
441443
filepath.write(chunk)
442444
return_path = filepath
443445
else:
446+
params = fix_filename(params)
444447
filename = to_filename(os.path.basename(params["filename"]))
445448
download_path = make_download_path(filepath, filename)
446449
with open(download_path, "wb") as f:

0 commit comments

Comments
 (0)
0