Skip to content

First pass at options builder #212

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

Closed
LGraber wants to merge 1 commit into from
Closed

First pass at options builder #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions samples/options_builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import sys

import tableauserverclient as TSC

rob = TSC.RequestOptions.Builder()
ro = rob.file("==", "MyFile").project("==", "Default")._sort("foo", "desc")._pagesize(50)._build()
print ro.filters
19 changes: 16 additions & 3 deletions tableauserverclient/server/filter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
from .request_options import RequestOptions
class Filter(object):
class Operator:
Equals = 'eq'
GreaterThan = 'gt'
GreaterThanOrEqual = 'gte'
LessThan = 'lt'
LessThanOrEqual = 'lte'
In = 'in'

_map = {"==": Equals, ">": GreaterThan, ">=": GreaterThanOrEqual,
"<": LessThan, "<=": LessThanOrEqual, "in": In}

@staticmethod
def map(val):
return Filter.Operator._map[val]


class Filter(object):
def __init__(self, field, operator, value):
self.field = field
self.operator = operator
Expand All @@ -20,7 +33,7 @@ def value(self):

@value.setter
def value(self, filter_value):
if isinstance(filter_value, list) and self.operator != RequestOptions.Operator.In:
if isinstance(filter_value, list) and self.operator != Filter.Operator.In:
error = "Filter values can only be a list if the operator is 'in'."
raise ValueError(error)
else:
Expand Down
32 changes: 32 additions & 0 deletions tableauserverclient/server/request_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
from .filter import Filter
from .sort import Sort

class RequestOptionsBase(object):
def apply_query_params(self, url):
raise NotImplementedError()
Expand Down Expand Up @@ -25,6 +28,35 @@ class Direction:
Desc = 'desc'
Asc = 'asc'

class Builder:
def __init__(self):
self.__pagenumber = 1
Copy link
Copy Markdown
Collaborator

@t8y8 t8y8 Aug 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure the __ is necessary (it invokes name mangling to avoid inheritance problems but here I think you can just make it the _... it's more 'polite' form :P

Copy link
Copy Markdown
Contributor Author

@LGraber LGraber Aug 9, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The double underscore was needed to disambiguate with the call to _pagenumber that I was specifically handling. If I don't do this, it actually fails

self.__pagesize = 100
self.__filters = set()
self.__sorts = set()

def __getattr__(self, attr):
def fn(*args, **kwargs):
if (attr == '_sort'):
self.__sorts.add(Sort(args[0], args[1]))
return self
elif (attr == '_pagenumber'):
self.__pagenumber = args[0]
return self
elif (attr == '_pagesize'):
self.__pagesize = args[0]
return self
elif (attr == '_build'):
ro = RequestOptions(self.__pagenumber, self.__pagesize)
ro.filter = self.__filters
ro.sort = self.__sorts
return ro
else:
self.__filters.add(Filter(attr, Filter.Operator.map(args[0]), args[1]))
return self
return fn


def __init__(self, pagenumber=1, pagesize=100):
self.pagenumber = pagenumber
self.pagesize = pagesize
Expand Down