feat: consolidate and export public type aliases (HyperAction, FilePath, AddResponse, IDP types)#1825
Open
jacalata wants to merge 8 commits into
Open
feat: consolidate and export public type aliases (HyperAction, FilePath, AddResponse, IDP types)#1825jacalata wants to merge 8 commits into
jacalata wants to merge 8 commits into
Conversation
Add Read the Docs configuration file for documentation build
Added configuration settings for Sphinx documentation. Direct copy from example conf file.
Updated project information to load from pyproject.toml.
- Add docs optional-dependencies group (sphinx, tomli) to pyproject.toml - Wire up .readthedocs.yaml to install .[docs] extra - Fix conf.py: correct pyproject.toml path, use importlib.metadata for version, switch to alabaster theme, use tomllib/tomli compat import - Add minimal docs/index.rst - Fix RST docstring errors in connection_item, site_item, job_item, task_item that caused Sphinx build warnings/errors Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
On push to master, builds Sphinx HTML and opens a PR from docs-update into gh-pages so the generated API reference can be reviewed before going live. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ient.types HyperAction*, FilePath, FileObject*, PathOrFile*, AddResponse, IDPAttributes, IDPProperty, and HasIdpConfigurationID were defined locally in endpoint files (in some cases duplicated across 4 files) but not importable from the top-level package. Users annotating calls to update_hyper_data(), publish(), download(), add_to_schedule(), or OIDC methods had to import from internal modules. Move all shared type aliases to tableauserverclient/types.py and re-export from tableauserverclient/__init__.py. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
HyperAction,HyperActionTable,HyperActionRow,HyperActionCondition— needed to annotate theactionsargument todatasources.update_hyper_data()FilePath,FileObject,FileObjectR,FileObjectW,PathOrFile,PathOrFileR,PathOrFileW— needed to annotatepublish()/download()arguments across datasources, workbooks, flows, and custom views; were duplicated across 4 endpoint filesAddResponse— return type ofschedules.add_to_schedule(), also used by the same method on datasources, workbooks, and flowsIDPAttributes,IDPProperty,HasIdpConfigurationID— needed to annotate arguments tooidc.get_by_id()andoidc.delete_configuration()All types are now defined in
tableauserverclient/types.pyand exported fromtableauserverclient/__init__.py. The endpoint files import fromtypes.pyinstead of defining them locally.Test plan
pytest test/)from tableauserverclient import HyperAction, FilePath, AddResponse, HasIdpConfigurationID🤖 Generated with Claude Code