Skip to content

Commit ed9dc74

Browse files
committed
docs: create_users_csv docstring
1 parent f8e7bd0 commit ed9dc74

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

tableauserverclient/server/endpoint/users_endpoint.py

+11-3
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

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

605603
return super().filter(*invalid, page_size=page_size, **kwargs)
606604

605+
607606
def create_users_csv(users: Iterable[UserItem], identity_pool=None) -> bytes:
608607
"""
609-
Create a CSV byte string from an Iterable of UserItem objects
608+
Create a CSV byte string from an Iterable of UserItem objects. The CSV will
609+
have the following columns, and no header row:
610+
611+
- Username
612+
- Password
613+
- Display Name
614+
- License
615+
- Admin Level
616+
- Publish capability
617+
- Email
610618
"""
611619
if identity_pool is not None:
612620
raise NotImplementedError("Identity pool is not supported in this version")

0 commit comments

Comments
 (0)