Skip to content

fix: correct Filter serialization for datetimes and booleans#1805

Open
jacalata wants to merge 3 commits into
developmentfrom
jac/fix-date-filter-encoding
Open

fix: correct Filter serialization for datetimes and booleans#1805
jacalata wants to merge 3 commits into
developmentfrom
jac/fix-date-filter-encoding

Conversation

@jacalata

Copy link
Copy Markdown
Contributor

Summary

  • Fixes datetime filter values producing wrong format ("2023-01-01 00:00:00" with space separator) instead of Tableau's required ISO-8601 UTC format ("2023-01-01T00:00:00Z"); this was causing server 400 errors for any datetime filter
  • Serializes boolean filter values as lowercase true/false as required by the Tableau REST API; Python's default True/False caused 400 errors on fields like isCertified and hasExtracts
  • Raises ValueError for naive datetimes (no tzinfo) instead of silently producing a wrong-timezone value; naive datetimes were already broken before this fix (server 400), so this is not a regression
  • Adds docstring to Filter.__str__ documenting all value type serialization rules

Closes #1025

Schema compliance

Verified against ts-api_3_29.xsd:

  • xs:dateTime fields match TABLEAU_DATE_FORMAT = "%Y-%m-%dT%H:%M:%SZ" exactly
  • xs:boolean fields (isCertified, hasExtracts, etc.) require lowercase true/false
  • Enum-typed fields (siteRole, jobType, etc.) serialize correctly via the existing str() fallback

Test plan

  • python -m pytest test/test_filter.py -v -- 14 tests, all pass
  • mypy: no issues
  • Verify createdAt:lt:2023-01-01T00:00:00Z in filter string (no %3A)
  • Verify non-UTC aware datetime is converted to UTC correctly
  • Verify naive datetime raises ValueError
  • Verify isCertified:eq:true and hasExtracts:eq:false (not True/False)

🤖 Generated with Claude Code

jacalata and others added 3 commits June 25, 2026 21:52
Fixes #1025

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Tableau REST API requires boolean filter values to be lowercase
('true'/'false'), but Python's str(bool) produces 'True'/'False'.
Add explicit bool handling in Filter.__str__ alongside the existing
datetime fix, and expand test coverage to include bool, int, datetime
(format, timezone conversion, no-encoding), list edge cases, and the
invalid-operator-with-list guard.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Naive datetime objects passed to Filter now raise ValueError with a
clear message instead of silently converting using the local system
timezone, which would produce wrong UTC values on any non-UTC machine.
Also adds a docstring to Filter.__str__ documenting the serialization
rules for all supported value types.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Coverage

Coverage Report
FileStmtsMissCoverMissing
tableauserverclient
   __init__.py50100% 
   config.py150100% 
   datetime_helpers.py2511 96%
   exponential_backoff.py200100% 
   filesys_helpers.py310100% 
   namespace.py2633 88%
tableauserverclient/bin
   __init__.py20100% 
   _version.py358212212 41%
tableauserverclient/helpers
   __init__.py10100% 
   logging.py20100% 
   strings.py3111 97%
tableauserverclient/models
   __init__.py460100% 
   collection_item.py4177 83%
   column_item.py553232 42%
   connection_credentials.py351111 69%
   connection_item.py941414 85%
   custom_view_item.py1442121 85%
   data_acceleration_report_item.py5411 98%
   data_alert_item.py15844 97%
   data_freshness_policy_item.py1551515 90%
   database_item.py2073636 83%
   datasource_item.py3001212 96%
   dqw_item.py10455 95%
   exceptions.py40100% 
   extensions_item.py13244 97%
   extract_item.py4444 91%
   favorites_item.py6988 88%
   fileupload_item.py190100% 
   flow_item.py1491010 93%
   flow_run_item.py710100% 
   group_item.py8966 93%
   groupset_item.py4977 86%
   interval_item.py1823232 82%
   job_item.py1871010 95%
   linked_tasks_item.py7911 99%
   location_item.py2922 93%
   metric_item.py1291313 90%
   oidc_item.py6333 95%
   pagination_item.py3411 97%
   permissions_item.py1111212 89%
   project_item.py2073131 85%
   property_decorators.py1001818 82%
   reference_item.py2622 92%
   revision_item.py5911 98%
   schedule_item.py20966 97%
   server_info_item.py3777 81%
   site_item.py6361313 98%
   subscription_item.py10122 98%
   table_item.py1191818 85%
   tableau_auth.py612525 59%
   tableau_types.py2711 96%
   tag_item.py150100% 
   target.py60100% 
   task_item.py5622 96%
   user_item.py3101818 94%
   view_item.py2201616 93%
   virtual_connection_item.py6488 88%
   webhook_item.py6911 99%
   workbook_item.py3621616 96%
tableauserverclient/server
   __init__.py90100% 
   exceptions.py40100% 
   filter.py2911 97%
   pager.py3311 97%
   query.py1431515 90%
   request_factory.py1335195195 85%
   request_options.py38655 99%
   server.py1882323 88%
   sort.py60100% 
tableauserverclient/server/endpoint
   __init__.py350100% 
   auth_endpoint.py771111 86%
   custom_views_endpoint.py1521212 92%
   data_acceleration_report_endpoint.py210100% 
   data_alert_endpoint.py942323 76%
   databases_endpoint.py1113030 73%
   datasources_endpoint.py3403535 90%
   default_permissions_endpoint.py4433 93%
   dqw_endpoint.py451616 64%
   endpoint.py1871818 90%
   exceptions.py7766 92%
   extensions_endpoint.py310100% 
   favorites_endpoint.py942222 77%
   fileuploads_endpoint.py510100% 
   flow_runs_endpoint.py6299 85%
   flow_task_endpoint.py2122 90%
   flows_endpoint.py2165555 75%
   groups_endpoint.py12699 93%
   groupsets_endpoint.py7277 90%
   jobs_endpoint.py6799 87%
   linked_tasks_endpoint.py370100% 
   metadata_endpoint.py881414 84%
   metrics_endpoint.py5566 89%
   oidc_endpoint.py4211 98%
   permissions_endpoint.py4433 93%
   projects_endpoint.py1572424 85%
   resource_tagger.py1273535 72%
   schedules_endpoint.py1191111 91%
   server_info_endpoint.py361010 72%
   sites_endpoint.py1302727 79%
   subscriptions_endpoint.py561414 75%
   tables_endpoint.py1103636 67%
   tasks_endpoint.py6366 90%
   users_endpoint.py18388 96%
   views_endpoint.py15099 94%
   virtual_connections_endpoint.py1131010 91%
   webhooks_endpoint.py5499 83%
   workbooks_endpoint.py3542424 93%
TOTAL12007142788% 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

filtering with dates is wrongly encoded

1 participant