Merge pull request #1372 from jorwoods/jorwoods/reqopts_filter_parameters

feat: pass parameters in request options

Author: jacalata

pyproject.toml

@@ -16,6 +16,7 @@ dependencies = [
     'packaging>=23.1',   # latest as at 7/31/23
     'requests>=2.31',  # latest as at 7/31/23
     'urllib3==2.0.7',  # latest as at 7/31/23
+    'typing_extensions>=4.0.1',
 ]
 requires-python = ">=3.7"
 classifiers = [

tableauserverclient/server/request_options.py

@@ -1,5 +1,7 @@
 import sys
 
+from typing_extensions import Self
+
 from tableauserverclient.models.property_decorators import property_is_int
 import logging
 
@@ -154,17 +156,27 @@ class _FilterOptionsBase(RequestOptionsBase):
 
     def __init__(self):
         self.view_filters = []
+        self.view_parameters = []
 
     def get_query_params(self):
         raise NotImplementedError()
 
-    def vf(self, name, value):
+    def vf(self, name: str, value: str) -> Self:
+        """Apply a filter to the view for a filter that is a normal column
+        within the view."""
         self.view_filters.append((name, value))
         return self
 
-    def _append_view_filters(self, params):
+    def parameter(self, name: str, value: str) -> Self:
+        """Apply a filter based on a parameter within the workbook."""
+        self.view_parameters.append((name, value))
+        return self
+
+    def _append_view_filters(self, params) -> None:
         for name, value in self.view_filters:
             params["vf_" + name] = value
+        for name, value in self.view_parameters:
+            params[name] = value
 
 
 class CSVRequestOptions(_FilterOptionsBase):

test/test_request_option.py

@@ -2,6 +2,7 @@
 from pathlib import Path
 import re
 import unittest
+from urllib.parse import parse_qs
 
 import requests_mock
 
@@ -311,3 +312,22 @@ def test_slicing_queryset_multi_page(self) -> None:
     def test_queryset_filter_args_error(self) -> None:
         with self.assertRaises(RuntimeError):
             workbooks = self.server.workbooks.filter("argument")
+
+    def test_filtering_parameters(self) -> None:
+        self.server.version = "3.6"
+        with requests_mock.mock() as m:
+            m.get(requests_mock.ANY)
+            url = self.baseurl + "/views/456/data"
+            opts = TSC.PDFRequestOptions()
+            opts.parameter("name1@", "value1")
+            opts.parameter("name2$", "value2")
+            opts.page_type = TSC.PDFRequestOptions.PageType.Tabloid
+
+            resp = self.server.workbooks.get_request(url, request_object=opts)
+            query_params = parse_qs(resp.request.query)
+            self.assertIn("name1@", query_params)
+            self.assertIn("value1", query_params["name1@"])
+            self.assertIn("name2$", query_params)
+            self.assertIn("value2", query_params["name2$"])
+            self.assertIn("type", query_params)
+            self.assertIn("tabloid", query_params["type"])