Add get_by_name to Users, Groups, and Schedules endpoints (unique-by-name types)

Offen

#1,837 erstellt am 28.7.2026 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 68/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Ruhig
Tech-Stack: python
Bereich: api

Rechercherichtung

Start with the UsersEndpoint, GroupsEndpoint, and SchedulesEndpoint implementations and compare them with the existing SitesEndpoint.get_by_name method. Add matching unique-name lookups that return the first result or None, then run the relevant endpoint tests and confirm the three methods follow the documented get_by_* behavior.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

enhancement

Sites already has get_by_name(site_name) -> SiteItem. Three other endpoints have server-enforced unique names and would benefit from the same shape:

Users — usernames unique per site.
Groups — group names unique per site.
Schedules — server throws ScheduleNameExistsException on duplicate name.

Proposal:

# UsersEndpoint
def get_by_name(self, username: str) -> UserItem | None:
    matches = list(self.filter(name=username))
    return matches[0] if matches else None

This formalizes a naming pattern across the API surface:

get_by_* returns a single item (or None/raises when not found). Use when the lookup key is unique on the server.
filter(...) returns a lazy QuerySet[T] for chaining or when multiplicity is possible.

Callers with unique-name types get a natural T | None shape. Callers with multi-name endpoints (workbooks/datasources/views/flows/projects) continue to use .filter(name=name).

🤖 Generated with Claude Code

Vorherrschende Sprache: Python
Sterne: 716
Forks: 446
Ø Merge: 8 T. 8 Std.
Gemergte PRs (30 T.): 2

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus tableau/server-client-python

UserItem.CSVImport.create_from_file: wrong file-extension check Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100

tableau/server-client-python#1865 · Erstellt am 17.8.2026
security: _validate_import_line_or_throw logs credential fields at DEBUG level Offen

in-progress

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100

tableau/server-client-python#1829 · 1 Kommentar · Erstellt am 23.7.2026
Add usageStatistics Param to view.get_by_id Method Offen

enhancement gap needs investigation

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

tableau/server-client-python#1322 · 1 Kommentar · Erstellt am 14.11.2023
[Type2] Allow Incremental Refresh type schedules to be added via `server.schedules.add_to_schedule` Offen

help wanted Server-Side Enhancement ui-exists

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

tableau/server-client-python#1101 · 3 Kommentare · Erstellt am 06.9.2022
Delete default permissions does not take in a list Offen

enhancement good first issue

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

tableau/server-client-python#783 · 5 Kommentare · Erstellt am 22.1.2021

Alle Issues in tableau/server-client-python