Skip to content

Commit 307d5dd

Browse files
committed
docs: create_users_csv docstring
1 parent 01660e0 commit 307d5dd

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

tableauserverclient/server/endpoint/users_endpoint.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
import itertools
66
import logging
77
from typing import Optional
8-
from pathlib import Path
9-
import re
108

119
from tableauserverclient.server.query import QuerySet
1210

@@ -621,9 +619,19 @@ def filter(self, *invalid, page_size: Optional[int] = None, **kwargs) -> QuerySe
621619

622620
return super().filter(*invalid, page_size=page_size, **kwargs)
623621

622+
624623
def create_users_csv(users: Iterable[UserItem], identity_pool=None) -> bytes:
625624
"""
626-
Create a CSV byte string from an Iterable of UserItem objects
625+
Create a CSV byte string from an Iterable of UserItem objects. The CSV will
626+
have the following columns, and no header row:
627+
628+
- Username
629+
- Password
630+
- Display Name
631+
- License
632+
- Admin Level
633+
- Publish capability
634+
- Email
627635
"""
628636
if identity_pool is not None:
629637
raise NotImplementedError("Identity pool is not supported in this version")

0 commit comments

Comments
 (0)