Skip to content

module/gsuite.py

module.gsuite

GSuite

GSuite

GSuite

Parameters:

Name Type Description Default
credentialfile str

The path to a JSON file.

 required
with_subject str

Email address of the Google Workspace admin.

 required
Source code in module/gsuite.py 
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
class GSuite:
    ''' GSuite

    Args:
        credentialfile (str): The path to a JSON file.
        with_subject (str): Email address of the Google Workspace admin.

    '''
    __slots__ = ('service', )

    SCOPES = ('https://www.googleapis.com/auth/admin.directory.user',
              'https://www.googleapis.com/auth/admin.directory.group',
              )

    def __init__(self, credentialfile: str, with_subject: str):
        creds = service_account.Credentials.from_service_account_file(
            credentialfile, scopes=self.SCOPES).with_subject(with_subject)

        self.service = build('admin', 'directory_v1',
                             credentials=creds, cache_discovery=False)

    @property
    def print_scopes(self) -> str:
        ''' Print the scopes

        Returns:
            Return an long strings and be chained by `,`.

        '''
        return ','.join(self.SCOPES)

    # ----- Users.list ----- #
    def users_list(self) -> Any:
        ''' Users.list

        Reference:

            - https://googleapis.github.io/google-api-python-client/docs/dyn/\
admin_directory_v1.users.html#list

        '''
        return self.service.users().list(customer='my_customer', orderBy='email').execute()

    # ----- Users.get ----- #
    def users_get(self, user_key: str) -> Any:
        ''' Users.get

        Args:
            user_key (str): mail or google user id.

        Reference:

            - https://googleapis.github.io/google-api-python-client/docs/\
dyn/admin_directory_v1.users.html#get

        '''
        return self.service.users().get(userKey=user_key).execute()

    # ----- Groups ----- #
    def groups_get(self, group_key: str) -> Any:
        ''' Groups.get

        Args:
            group_key (str): mail or group id.

        Reference:

            - https://developers.google.com/admin-sdk/directory/v1/reference/groups
            - https://googleapis.github.io/google-api-python-client/docs/\
dyn/admin_directory_v1.groups.html

        '''
        return self.service.groups().get(groupKey=group_key).execute()

    # ----- Groups.list ----- #
    def groups_list(self, page_token: Union[str, None] = None) -> Any:
        ''' Groups.list

        Args:
            page_token (str): The next page token, it will be supplied in
                              the result if has the next page.

        Reference:

            - https://googleapis.github.io/google-api-python-client/docs/\
dyn/admin_directory_v1.groups.html#list

        '''
        return self.service.groups().list(customer='my_customer',
                                          orderBy='email', pageToken=page_token).execute()

    def groups_list_loop(self, page_token: Union[str, None] = None) ->\
            Generator[dict[str, str], None, None]:
        ''' Groups.list.loop

        Args:
            page_token (str): The next page token, it will be supplied in
                              the result if has the next page.

        '''
        groups = self.groups_list(page_token=page_token)
        for group in groups['groups']:
            yield group

        if 'nextPageToken' in groups:
            for group in self.groups_list_loop(page_token=groups['nextPageToken']):
                yield group

    def groups_insert(self, email: str, description: Union[str, None] = None,
                      name: Union[str, None] = None) -> Any:
        ''' Groups.insert

        Args:
            email (str): Email.
            description (str): Description.
            name (str): Group name.

        '''
        body = {'email': email}
        if description is not None:
            body['description'] = description

        if name is not None:
            body['name'] = name

        return self.service.groups().insert(body=body).execute()

    # ----- Members ----- #
    def members_list(self, group_key: str, page_token: Union[str, None] = None) -> Any:
        ''' members.list

        Args:
            group_key (str): mail or group id.
            page_token (str): The next page token, it will be supplied in
                              the result if has the next page.

        Reference:

            - https://developers.google.com/admin-sdk/directory/v1/reference/members
            - https://googleapis.github.io/google-api-python-client/docs/\
dyn/admin_directory_v1.members.html

        '''
        return self.service.members().list(groupKey=group_key, pageToken=page_token).execute()

    def members_list_loop(self, group_key: str) -> Generator[dict[str, str], None, None]:
        ''' members.list.loop

        Args:
            group_key (str): mail or group id.

        '''
        members = self.members_list(group_key)
        for member in members.get('members', []):
            yield member

        while 'nextPageToken' in members:
            members = self.members_list(
                group_key, page_token=members['nextPageToken'])
            for member in members.get('members', []):
                yield member

    def members_insert(self, group_key: str, email: str,
                       role: str = 'MEMBER', delivery_settings: str = 'ALL_MAIL') -> Any:
        ''' members.insert

        Args:
            group_key (str): mail or group id.
            email (str): Email.
            role (str): `MANAGER`, `MEMBER`, `OWNER`
            delivery_settings (str): `ALL_MAIL`, `DAILY`, `DIGEST`, `DISABLED`, `NONE`.

        Reference:

            - https://developers.google.com/admin-sdk/directory/reference/rest/v1/members

        '''
        body = {'email': email, 'role': role,
                'delivery_settings': delivery_settings}
        return self.service.members().insert(groupKey=group_key, body=body).execute()

    def members_has_member(self, group_key: str, email: str) -> dict[str, bool]:
        ''' members.hasMember

        Args:
            group_key (str): mail or group id.
            email (str): Email.

        '''
        try:
            if self.members_get(group_key=group_key, email=email):
                return {'isMember': True}
            return {'isMember': False}
        except errors.HttpError:
            return {'isMember': False}

    def members_get(self, group_key: str, email: str) -> Any:
        ''' members.get

        Args:
            group_key (str): mail or group id.
            email (str): Email.

        '''
        return self.service.members().get(groupKey=group_key, memberKey=email).execute()

    def members_delete(self, group_key: str, email: str) -> Any:
        ''' members.delete

        Args:
            group_key (str): mail or group id.
            email (str): Email.

        '''
        return self.service.members().delete(groupKey=group_key, memberKey=email).execute()

    @staticmethod
    def size_picture(url: str, size: int = 512) -> str:
        ''' Convert picture size

        Args:
            url (str): The url of the image.
            size (int): Replace the size.

        Returns:
            Return the url of the right size of the image.

        '''
        result = RE_PICTURE.match(url)

        if result:
            _url, _size = result.groups()
            return url.replace(f's{_size}', f's{size}-c')

        return url

print_scopes property 

print_scopes: str

Print the scopes

Returns:

Type Description
str

Return an long strings and be chained by ,.

groups_get 

groups_get(group_key: str) -> Any

Groups.get

Parameters:

Name Type Description Default
group_key str

mail or group id.

 required

Reference:

- https://developers.google.com/admin-sdk/directory/v1/reference/groups
- https://googleapis.github.io/google-api-python-client/docs/dyn/admin_directory_v1.groups.html
Source code in module/gsuite.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
    def groups_get(self, group_key: str) -> Any:
        ''' Groups.get

        Args:
            group_key (str): mail or group id.

        Reference:

            - https://developers.google.com/admin-sdk/directory/v1/reference/groups
            - https://googleapis.github.io/google-api-python-client/docs/\
dyn/admin_directory_v1.groups.html

        '''
        return self.service.groups().get(groupKey=group_key).execute()

groups_insert 

groups_insert(
    email: str,
    description: Union[str, None] = None,
    name: Union[str, None] = None,
) -> Any

Groups.insert

Parameters:

Name Type Description Default
email str

Email.

 required
description str

Description.

 None
name str

Group name.

 None
Source code in module/gsuite.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def groups_insert(self, email: str, description: Union[str, None] = None,
                  name: Union[str, None] = None) -> Any:
    ''' Groups.insert

    Args:
        email (str): Email.
        description (str): Description.
        name (str): Group name.

    '''
    body = {'email': email}
    if description is not None:
        body['description'] = description

    if name is not None:
        body['name'] = name

    return self.service.groups().insert(body=body).execute()

groups_list 

groups_list(page_token: Union[str, None] = None) -> Any

Groups.list

Parameters:

Name Type Description Default
page_token str

The next page token, it will be supplied in the result if has the next page.

 None

Reference:

- https://googleapis.github.io/google-api-python-client/docs/dyn/admin_directory_v1.groups.html#list
Source code in module/gsuite.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
    def groups_list(self, page_token: Union[str, None] = None) -> Any:
        ''' Groups.list

        Args:
            page_token (str): The next page token, it will be supplied in
                              the result if has the next page.

        Reference:

            - https://googleapis.github.io/google-api-python-client/docs/\
dyn/admin_directory_v1.groups.html#list

        '''
        return self.service.groups().list(customer='my_customer',
                                          orderBy='email', pageToken=page_token).execute()

groups_list_loop 

groups_list_loop(
    page_token: Union[str, None] = None
) -> Generator[dict[str, str], None, None]

Groups.list.loop

Parameters:

Name Type Description Default
page_token str

The next page token, it will be supplied in the result if has the next page.

 None
Source code in module/gsuite.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def groups_list_loop(self, page_token: Union[str, None] = None) ->\
        Generator[dict[str, str], None, None]:
    ''' Groups.list.loop

    Args:
        page_token (str): The next page token, it will be supplied in
                          the result if has the next page.

    '''
    groups = self.groups_list(page_token=page_token)
    for group in groups['groups']:
        yield group

    if 'nextPageToken' in groups:
        for group in self.groups_list_loop(page_token=groups['nextPageToken']):
            yield group

members_delete 

members_delete(group_key: str, email: str) -> Any

members.delete

Parameters:

Name Type Description Default
group_key str

mail or group id.

 required
email str

Email.

 required
Source code in module/gsuite.py 
220
221
222
223
224
225
226
227
228
def members_delete(self, group_key: str, email: str) -> Any:
    ''' members.delete

    Args:
        group_key (str): mail or group id.
        email (str): Email.

    '''
    return self.service.members().delete(groupKey=group_key, memberKey=email).execute()

members_get 

members_get(group_key: str, email: str) -> Any

members.get

Parameters:

Name Type Description Default
group_key str

mail or group id.

 required
email str

Email.

 required
Source code in module/gsuite.py 
210
211
212
213
214
215
216
217
218
def members_get(self, group_key: str, email: str) -> Any:
    ''' members.get

    Args:
        group_key (str): mail or group id.
        email (str): Email.

    '''
    return self.service.members().get(groupKey=group_key, memberKey=email).execute()

members_has_member 

members_has_member(
    group_key: str, email: str
) -> dict[str, bool]

members.hasMember

Parameters:

Name Type Description Default
group_key str

mail or group id.

 required
email str

Email.

 required
Source code in module/gsuite.py 
195
196
197
198
199
200
201
202
203
204
205
206
207
208
def members_has_member(self, group_key: str, email: str) -> dict[str, bool]:
    ''' members.hasMember

    Args:
        group_key (str): mail or group id.
        email (str): Email.

    '''
    try:
        if self.members_get(group_key=group_key, email=email):
            return {'isMember': True}
        return {'isMember': False}
    except errors.HttpError:
        return {'isMember': False}

members_insert 

members_insert(
    group_key: str,
    email: str,
    role: str = "MEMBER",
    delivery_settings: str = "ALL_MAIL",
) -> Any

members.insert

Parameters:

Name Type Description Default
group_key str

mail or group id.

 required
email str

Email.

 required
role str

MANAGER, MEMBER, OWNER

 'MEMBER'
delivery_settings str

ALL_MAIL, DAILY, DIGEST, DISABLED, NONE.

 'ALL_MAIL'

Reference:

- https://developers.google.com/admin-sdk/directory/reference/rest/v1/members
Source code in module/gsuite.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def members_insert(self, group_key: str, email: str,
                   role: str = 'MEMBER', delivery_settings: str = 'ALL_MAIL') -> Any:
    ''' members.insert

    Args:
        group_key (str): mail or group id.
        email (str): Email.
        role (str): `MANAGER`, `MEMBER`, `OWNER`
        delivery_settings (str): `ALL_MAIL`, `DAILY`, `DIGEST`, `DISABLED`, `NONE`.

    Reference:

        - https://developers.google.com/admin-sdk/directory/reference/rest/v1/members

    '''
    body = {'email': email, 'role': role,
            'delivery_settings': delivery_settings}
    return self.service.members().insert(groupKey=group_key, body=body).execute()

members_list 

members_list(
    group_key: str, page_token: Union[str, None] = None
) -> Any

members.list

Parameters:

Name Type Description Default
group_key str

mail or group id.

 required
page_token str

The next page token, it will be supplied in the result if has the next page.

 None

Reference:

- https://developers.google.com/admin-sdk/directory/v1/reference/members
- https://googleapis.github.io/google-api-python-client/docs/dyn/admin_directory_v1.members.html
Source code in module/gsuite.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
    def members_list(self, group_key: str, page_token: Union[str, None] = None) -> Any:
        ''' members.list

        Args:
            group_key (str): mail or group id.
            page_token (str): The next page token, it will be supplied in
                              the result if has the next page.

        Reference:

            - https://developers.google.com/admin-sdk/directory/v1/reference/members
            - https://googleapis.github.io/google-api-python-client/docs/\
dyn/admin_directory_v1.members.html

        '''
        return self.service.members().list(groupKey=group_key, pageToken=page_token).execute()

members_list_loop 

members_list_loop(
    group_key: str,
) -> Generator[dict[str, str], None, None]

members.list.loop

Parameters:

Name Type Description Default
group_key str

mail or group id.

 required
Source code in module/gsuite.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def members_list_loop(self, group_key: str) -> Generator[dict[str, str], None, None]:
    ''' members.list.loop

    Args:
        group_key (str): mail or group id.

    '''
    members = self.members_list(group_key)
    for member in members.get('members', []):
        yield member

    while 'nextPageToken' in members:
        members = self.members_list(
            group_key, page_token=members['nextPageToken'])
        for member in members.get('members', []):
            yield member

size_picture staticmethod 

size_picture(url: str, size: int = 512) -> str

Convert picture size

Parameters:

Name Type Description Default
url str

The url of the image.

 required
size int

Replace the size.

 512

Returns:

Type Description
str

Return the url of the right size of the image.
Source code in module/gsuite.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
@staticmethod
def size_picture(url: str, size: int = 512) -> str:
    ''' Convert picture size

    Args:
        url (str): The url of the image.
        size (int): Replace the size.

    Returns:
        Return the url of the right size of the image.

    '''
    result = RE_PICTURE.match(url)

    if result:
        _url, _size = result.groups()
        return url.replace(f's{_size}', f's{size}-c')

    return url

users_get 

users_get(user_key: str) -> Any

Users.get

Parameters:

Name Type Description Default
user_key str

mail or google user id.

 required

Reference:

- https://googleapis.github.io/google-api-python-client/docs/dyn/admin_directory_v1.users.html#get
Source code in module/gsuite.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
    def users_get(self, user_key: str) -> Any:
        ''' Users.get

        Args:
            user_key (str): mail or google user id.

        Reference:

            - https://googleapis.github.io/google-api-python-client/docs/\
dyn/admin_directory_v1.users.html#get

        '''
        return self.service.users().get(userKey=user_key).execute()

users_list 

users_list() -> Any

Users.list

Reference:

- https://googleapis.github.io/google-api-python-client/docs/dyn/admin_directory_v1.users.html#list
Source code in module/gsuite.py 
46
47
48
49
50
51
52
53
54
55
    def users_list(self) -> Any:
        ''' Users.list

        Reference:

            - https://googleapis.github.io/google-api-python-client/docs/dyn/\
admin_directory_v1.users.html#list

        '''
        return self.service.users().list(customer='my_customer', orderBy='email').execute()