Skip to content

Users

NomadUser

Represents a user in the NOMAD system.

This class defines the structure for storing user information as retrieved from the NOMAD system. It includes both mandatory and optional fields, with some fields being hidden from the representation for privacy or security reasons.

Attributes:

Name Type Description
user_id str

A unique identifier for the user, not shown in the representation.
name str

The full name of the user.
first_name str

The user's first name, not shown in the representation.
last_name str

The user's last name, not shown in the representation.
username str

The user's username, not shown in the representation.
affiliation str

The user's affiliated institution or organization, not shown in the representation.
affiliation_address str

The address of the affiliated institution or organization, not shown in the representation.
email Optional[str]

The user's email address, optional and not shown in the representation.
is_oasis_admin Optional[bool]

Flag indicating if the user is an OASIS admin, optional and not shown in the representation.
is_admin Optional[bool]

Flag indicating if the user is an admin, optional and not shown in the representation.
repo_user_id Optional[str]

A repository-specific user identifier, optional and not shown in the representation.
created Optional[datetime]

The date and time when the user was created, optional and not shown in the representation.
Source code in martignac/nomad/users.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
@dataclass(frozen=True)
class NomadUser:
    """
    Represents a user in the NOMAD system.

    This class defines the structure for storing user information as retrieved from the NOMAD system. It includes
    both mandatory and optional fields, with some fields being hidden from the representation for privacy or
    security reasons.

    Attributes:
        user_id (str): A unique identifier for the user, not shown in the representation.
        name (str): The full name of the user.
        first_name (str): The user's first name, not shown in the representation.
        last_name (str): The user's last name, not shown in the representation.
        username (str): The user's username, not shown in the representation.
        affiliation (str): The user's affiliated institution or organization, not shown in the representation.
        affiliation_address (str): The address of the affiliated institution or organization, not shown in the representation.
        email (Optional[str]): The user's email address, optional and not shown in the representation.
        is_oasis_admin (Optional[bool]): Flag indicating if the user is an OASIS admin, optional and not shown in the representation.
        is_admin (Optional[bool]): Flag indicating if the user is an admin, optional and not shown in the representation.
        repo_user_id (Optional[str]): A repository-specific user identifier, optional and not shown in the representation.
        created (Optional[dt.datetime]): The date and time when the user was created, optional and not shown in the representation.
    """

    user_id: str = field(repr=False)
    name: str
    first_name: str = field(repr=False)
    last_name: str = field(repr=False)
    username: str = field(repr=False)
    affiliation: str = field(repr=False)
    affiliation_address: Optional[str] = field(repr=False)
    email: Optional[str] = field(repr=False, default=None)
    is_oasis_admin: Optional[bool] = field(repr=False, default=None)
    is_admin: Optional[bool] = field(repr=False, default=None)
    repo_user_id: Optional[str] = field(repr=False, default=None)
    created: Optional[dt.datetime] = field(repr=False, default=None)

    def as_dict(self) -> dict:
        return asdict(self)

get_user_by_id(user_id, use_prod=True, timeout_in_sec=10)

Retrieves a user's information from the NOMAD system by their unique user ID.

This function makes a request to the NOMAD system to fetch the details of a user specified by their unique identifier. It allows the choice between querying the production or test environment of the NOMAD system. The function also supports specifying a timeout for the request. The results are cached to optimize performance and reduce the load on the NOMAD system.

Parameters:

Name Type Description Default
user_id str

The unique identifier of the user to retrieve.

 required
use_prod bool

Flag indicating whether to use the production environment of the NOMAD system. Defaults to True.

 True
timeout_in_sec int

The maximum time in seconds to wait for a response from the NOMAD system. Defaults to 10 seconds.

 10

Returns:

Name Type Description
NomadUser NomadUser

An instance of NomadUser containing the retrieved user's information.
Note

The function is decorated with @ttl_cache to cache the results for 180 seconds and limit the cache size to 128 entries.

Source code in martignac/nomad/users.py 
 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
@ttl_cache(maxsize=128, ttl=180)
def get_user_by_id(
    user_id: str, use_prod: bool = True, timeout_in_sec: int = 10
) -> NomadUser:
    """
    Retrieves a user's information from the NOMAD system by their unique user ID.

    This function makes a request to the NOMAD system to fetch the details of a user specified by their unique identifier.
    It allows the choice between querying the production or test environment of the NOMAD system. The function also
    supports specifying a timeout for the request. The results are cached to optimize performance and reduce the load
    on the NOMAD system.

    Args:
        user_id (str): The unique identifier of the user to retrieve.
        use_prod (bool, optional): Flag indicating whether to use the production environment of the NOMAD system.
                                   Defaults to True.
        timeout_in_sec (int, optional): The maximum time in seconds to wait for a response from the NOMAD system.
                                        Defaults to 10 seconds.

    Returns:
        NomadUser: An instance of `NomadUser` containing the retrieved user's information.

    Note:
        The function is decorated with `@ttl_cache` to cache the results for 180 seconds and limit the cache size to 128 entries.
    """
    logger.info(f"retrieving user {user_id} on {'prod' if use_prod else 'test'} server")
    response = get_nomad_request(f"/users/{user_id}", timeout_in_sec=timeout_in_sec)
    user_schema = class_schema(NomadUser)
    return user_schema().load(response)

search_users_by_name(user_name, use_prod=True, timeout_in_sec=10)

Searches for users in the NOMAD system by name.

This function queries the NOMAD system for users whose names match the provided prefix. It leverages caching to reduce the number of requests made for the same query. The search can be directed to either the production or test environment of the NOMAD system. A timeout can be specified to limit the duration of the request.

Parameters:

Name Type Description Default
user_name str

The prefix of the user name to search for.

 required
use_prod bool

Flag indicating whether to use the production environment of the NOMAD system. Defaults to True.

 True
timeout_in_sec int

The maximum time in seconds to wait for a response from the NOMAD system. Defaults to 10 seconds.

 10

Returns:

Name Type Description
NomadUser NomadUser

An instance or list of NomadUser objects matching the search criteria.
Note

The function is decorated with @ttl_cache to cache the results for 180 seconds and limit the cache size to 128 entries.

Source code in martignac/nomad/users.py 
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
@ttl_cache(maxsize=128, ttl=180)
def search_users_by_name(
    user_name: str, use_prod: bool = True, timeout_in_sec: int = 10
) -> NomadUser:
    """
    Searches for users in the NOMAD system by name.

    This function queries the NOMAD system for users whose names match the provided prefix. It leverages caching to
    reduce the number of requests made for the same query. The search can be directed to either the production or
    test environment of the NOMAD system. A timeout can be specified to limit the duration of the request.

    Args:
        user_name (str): The prefix of the user name to search for.
        use_prod (bool, optional): Flag indicating whether to use the production environment of the NOMAD system.
                                   Defaults to True.
        timeout_in_sec (int, optional): The maximum time in seconds to wait for a response from the NOMAD system.
                                        Defaults to 10 seconds.

    Returns:
        NomadUser: An instance or list of `NomadUser` objects matching the search criteria.

    Note:
        The function is decorated with `@ttl_cache` to cache the results for 180 seconds and limit the cache size to 128 entries.
    """
    logger.info(
        f"retrieving user {user_name} on {'prod' if use_prod else 'test'} server"
    )
    response = get_nomad_request(
        f"/users?prefix={user_name}", timeout_in_sec=timeout_in_sec
    ).get("data", [])
    return [class_schema(NomadUser)().load(user) for user in response]

who_am_i(use_prod=True, timeout_in_sec=10)

Retrieves the information of the currently authenticated user from the NOMAD system.

This function makes a request to the NOMAD system to fetch the details of the currently authenticated user. It allows specifying whether to query the production or test environment of the NOMAD system. Additionally, a timeout for the request can be defined to manage how long the function waits for a response from the NOMAD system. The results are cached to improve performance and reduce the load on the NOMAD system.

Parameters:

Name Type Description Default
use_prod bool

Flag indicating whether to use the production environment of the NOMAD system. Defaults to True.

 True
timeout_in_sec int

The maximum time in seconds to wait for a response from the NOMAD system. Defaults to 10 seconds.

 10

Returns:

Name Type Description
NomadUser NomadUser

An instance of NomadUser containing the information of the currently authenticated user.
Note

The function is decorated with @ttl_cache to cache the results for 180 seconds and limit the cache size to 128 entries.

Source code in martignac/nomad/users.py 
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
@ttl_cache(maxsize=128, ttl=180)
def who_am_i(use_prod: bool = True, timeout_in_sec: int = 10) -> NomadUser:
    """
    Retrieves the information of the currently authenticated user from the NOMAD system.

    This function makes a request to the NOMAD system to fetch the details of the currently authenticated user.
    It allows specifying whether to query the production or test environment of the NOMAD system. Additionally,
    a timeout for the request can be defined to manage how long the function waits for a response from the NOMAD system.
    The results are cached to improve performance and reduce the load on the NOMAD system.

    Args:
        use_prod (bool, optional): Flag indicating whether to use the production environment of the NOMAD system.
                                   Defaults to True.
        timeout_in_sec (int, optional): The maximum time in seconds to wait for a response from the NOMAD system.
                                        Defaults to 10 seconds.

    Returns:
        NomadUser: An instance of `NomadUser` containing the information of the currently authenticated user.

    Note:
        The function is decorated with `@ttl_cache` to cache the results for 180 seconds and limit the cache size to 128 entries.
    """
    logger.info(f"retrieving self user info on {'prod' if use_prod else 'test'} server")
    response = get_nomad_request(
        "/users/me", with_authentication=True, timeout_in_sec=timeout_in_sec
    )
    user_schema = class_schema(NomadUser)
    return user_schema().load(response)