Add structural Protocol types for TSC item classes - #1802
Open
jacalata wants to merge 10 commits into
Open
Conversation
…gs type - Rename DefaultPermissionsEndpoint's local BaseItem alias to DefaultPermissionsTarget to avoid shadowing the new public Protocol - Remove _initial_tags from TaggableItem (internal dirty-tracking detail, not a public contract); update ContentItem docstring to include MetricItem - Narrow WorkbookItem._initial_tags and DatasourceItem._initial_tags annotations from bare set to set[str] for Protocol invariance compliance Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… __all__ Taggable in resource_tagger.py was never used as a type bound -- TaggableItem in base_item.py now covers the public contract. Also remove runtime_checkable import which became unused. Fix pre-existing duplicate SiteOIDCConfiguration entry in models/__init__.__all__. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ViewItem.owner_id is not independently writable (it tracks the parent workbook's owner), so a plain writable Protocol attribute annotation would mislead mypy. A @Property annotation satisfies both ViewItem's read-only property and the writable instance attributes on other item classes. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add test/test_protocols.py covering isinstance() checks for BaseItem, OwnedItem, TaggableItem, and ContentItem against all representative item classes (WorkbookItem, DatasourceItem, ViewItem, FlowItem, ProjectItem, MetricItem, UserItem) and plain structural objects, including negative cases and protocol-hierarchy checks. - Add _TaggableWithInitial private Protocol in resource_tagger.py to capture the _initial_tags implementation detail alongside the public TaggableItem surface; use it to fully annotate _ResourceTagger._add_tags, _delete_tag, and update_tags. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…test Add section comments to __init__.__all__ to distinguish the new structural protocols from the alphabetical concrete-model list. Move the inline `import datetime` in test_protocols.py to module level, matching the import style used throughout the test suite. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
|
This is great and will make other typing easier. Should they be named differently to clearly differentiate them? Something like |
Contributor
Author
|
Hm, I think underscores would make some more helpful IDEs hide/limit them in autocomplete etc, so not that. A common approach is something like "SupportsOwner", but that doesn't quite work for "ContentItem". I think the current item works ok and is pretty standard. |
…es.py
BaseItem is renamed to TableauItem to match the existing name in
tableau_types.py and fulfill its TODO comment ("should define TableauItem
as an interface"). The Union type alias is replaced with an import of the
Protocol, removing the need to enumerate concrete types.
id and name are now declared as @Property on the Protocol so that concrete
classes with read-only property implementations (and VirtualConnectionItem
whose name: str is narrower than str | None) satisfy it under mypy's
covariant property checking.
A private _PermissibleItem Protocol is added to permissions_endpoint.py
to type the populate() method's _set_permissions call, which is an
implementation detail not appropriate for the public TableauItem Protocol.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
Apparently an underscore prefix can get them ignored by some IDEs, so not that. I spent a while looking at other projects and it seems the standard two choices are "Thingable/SupportsThing" for atomic Protocols (like SupportsInt and SupportsFloat) or just "Thing". I think the current naming is ok. |
- base_item.py TableauItem docstring: fix the stale first paragraph that claimed "plain Protocol attributes (not @Property)". The code uses @Property; the docstring now matches. Also documents that TaskItem and DataAlertItem (no `name` attribute) don't satisfy the protocol, and calls out the issubclass-raises-TypeError gotcha for data-attribute Protocols. - __init__.py: export ContentItem, OwnedItem, TaggableItem from the top-level package. Previously only TableauItem was accessible as TSC.TableauItem; the other three were only under models/__init__.py, which meant TSC.ContentItem raised AttributeError. - test_protocols.py: add coverage for previously-untested types the original Union included. DatabaseItem, TableItem, VirtualConnectionItem positive on TableauItem; VirtualConnectionItem positive on OwnedItem and negative on TaggableItem (no `tags` attribute). TaskItem negative on TableauItem (has `id` but no `name`), validating the docstring's explicit exclusion. Plus an issubclass-raises-TypeError test to lock in the data-attribute Protocol limitation. Co-Authored-By: Claude Opus 4.7 (1M context) <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
2 participants
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
base_item.pywith fourruntime_checkableProtocol classes:TableauItem(id, name),OwnedItem(+ owner_id),TaggableItem(+ tags),and
ContentItem(+ created_at, updated_at), forming a composable hierarchy.tableauserverclient.modelsand from the top-leveltableauserverclientpackage.Taggableprotocol inresource_tagger.pywith aprivate
_TaggableWithInitialand fully annotates all_ResourceTaggermethod signatures.
BaseItemtype alias indefault_permissions_endpoint.pytoDefaultPermissionsTargetto avoid shadowing the new public Protocol._initial_tags: settoset[str]inDatasourceItemandWorkbookItemfor Protocol invariance compliance.SiteOIDCConfigurationentry frommodels.__all__.Behavior note
TableauItemis a structural Protocol, replacing theTableauItemUniontype formerly in
tableau_types.py. This widens the accepted type surface:any object with
idandnamenow satisfies annotations that formerlyrequired one of the Union members. Callers who relied on the narrow Union
get the same coverage plus more; callers who require narrower typing can
continue to name concrete item classes directly.
Items without a
nameattribute (e.g.TaskItem,DataAlertItem) do NOTsatisfy
TableauItem, and this is now covered by tests.Schema compliance
All five primary content types in ts-api_3_29.xsd (workbookType,
dataSourceType, viewType, flowType, metricType) carry id, name, owner, tags,
and createdAt/updatedAt attributes. The Protocol hierarchy matches the schema
exactly. MetricItem correctly satisfies ContentItem per schema confirmation.
Test plan
python -m pytest test/test_protocols.py -v-- all passTSC.TableauItem,TSC.ContentItem,TSC.OwnedItem,TSC.TaggableItemare all reachable from the top-level package.
isinstance(TSC.WorkbookItem(...), ContentItem)returnsTrueat runtime🤖 Generated with Claude Code