Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 8 additions & 2 deletions tableauserverclient/server/request_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ def get_query_params(self):
self._append_view_filters(params)
return params

def vf(self, name: str, value: str) -> Self:
def vf(self, name: str, value: str, operator: str | None = None) -> Self:
"""Apply a filter based on a column within the view.
Note that when filtering on a boolean type field, the only valid values are 'true' and 'false'

Expand All @@ -363,12 +363,18 @@ def vf(self, name: str, value: str) -> Self:
value: str
The value to filter on

operator: str, optional
A comparison operator from RequestOptions.Operator (e.g. 'gt', 'lte').
When provided the filter is encoded as ``operator:value``.
Defaults to an exact-match filter when omitted.

Returns
-------
Self
The current object
"""
self.view_filters.append((name, value))
encoded_value = f"{operator}:{value}" if operator else value
self.view_filters.append((name, encoded_value))
return self

def parameter(self, name: str, value: str) -> Self:
Expand Down
17 changes: 17 additions & 0 deletions test/test_request_option.py
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,23 @@ def test_vf(server: TSC.Server) -> None:
assert "tabloid" in query_string["type"]


def test_vf_with_operator(server: TSC.Server) -> None:
server.version = "3.23"
with requests_mock.mock() as m:
m.get(requests_mock.ANY)
url = server.workbooks.baseurl + "/456/data"
opts = TSC.PDFRequestOptions()
opts.vf("Sales", "1000", operator=TSC.RequestOptions.Operator.GreaterThan)
opts.vf("Region", "West")

resp = server.workbooks.get_request(url, request_object=opts)
query_string = parse_qs(resp.request.query)
assert "vf_sales" in query_string
assert "gt:1000" in query_string["vf_sales"]
assert "vf_region" in query_string
assert "west" in query_string["vf_region"]


# Test req_options for versions below 3.7
def test_vf_legacy(server: TSC.Server) -> None:
server.version = "3.6"
Expand Down
Loading