Map ftrack users to AYON users.
Mapping is based on 2 possible keys, email and username where email has higher priority. Once AYON user is mapped it cannot be mapped again to different user.
Fields used from ftrack users: 'id', 'username', 'email'.
Parameters:
| Name | Type | Description | Default |
ftrack_users | List[User] | | required |
ayon_users | List[Dict[str, Any]] | | None |
Returns:
| Type | Description |
Dict[str, Union[str, None]] | Dict[str, Union[str, None]]: Mapping of ftrack user id to AYON username. |
Source code in client/ayon_ftrack/common/users.py
11
12
13
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 | def map_ftrack_users_to_ayon_users(
ftrack_users: List["ftrack_api.entity.user.User"],
ayon_users: Optional[List[Dict[str, Any]]] = None,
) -> Dict[str, "Union[str, None]"]:
"""Map ftrack users to AYON users.
Mapping is based on 2 possible keys, email and username where email has
higher priority. Once AYON user is mapped it cannot be mapped again to
different user.
Fields used from ftrack users: 'id', 'username', 'email'.
Args:
ftrack_users (List[ftrack_api.entity.user.User]): List of ftrack users.
ayon_users (List[Dict[str, Any]]): List of AYON users.
Returns:
Dict[str, Union[str, None]]: Mapping of ftrack user id
to AYON username.
"""
if ayon_users is None:
ayon_users = ayon_api.get_users()
mapping: Dict[str, "Union[str, None]"] = {
user["id"]: None
for user in ftrack_users
}
ayon_users_by_email: Dict[str, str] = {}
ayon_users_by_name: Dict[str, str] = {}
for ayon_user in ayon_users:
ayon_name = ayon_user["name"]
ayon_email = ayon_user["attrib"]["email"]
ayon_users_by_name[ayon_name.lower()] = ayon_name
if ayon_email:
ayon_users_by_email[ayon_email.lower()] = ayon_name
mapped_ayon_users: Set[str] = set()
for ftrack_user in ftrack_users:
ftrack_id: str = ftrack_user["id"]
# Make sure username does not contain '@' character
ftrack_name: str = ftrack_user["username"].split("@", 1)[0]
ftrack_email: str = ftrack_user["email"]
if ftrack_email and ftrack_email.lower() in ayon_users_by_email:
ayon_name: str = ayon_users_by_email[ftrack_email.lower()]
if ayon_name not in mapped_ayon_users:
mapping[ftrack_id] = ayon_name
mapped_ayon_users.add(ayon_name)
continue
if ftrack_name in ayon_users_by_name:
ayon_name: str = ayon_users_by_name[ftrack_name]
if ayon_name not in mapped_ayon_users:
mapped_ayon_users.add(ayon_name)
mapping[ftrack_id] = ayon_name
return mapping
|