Skip to content

adalib.issues

The Issues sub-package exposes the core integrations of the issues in the AdaLab Gallery.

Functions

create_issue 

create_issue(card_id, message, username)

Create a new issue for a specific card in the Gallery.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
card_id int

id of the card to assign the issue to

 required
message str

message of the new issue

 required
username str

the current username (tip: check "LOGNAME" environment variable)

 required

Returns:

Type Description
int

id of the new issue
Source code in adalib/issues/issues.py 
 8
 9
10
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
def create_issue(card_id: int, message: str, username: str) -> int:
    """
    Create a new issue for a specific card in the Gallery.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/issues/create_issue.ipynb) to test this function or build upon it.

    :param card_id: id of the card to assign the issue to
    :type card_id: int
    :param message: message of the new issue
    :type message: str
    :param username: the current username (tip: check "LOGNAME" environment variable)
    :type username: str
    :return: id of the new issue
    :rtype: int
    """

    timestamp = dt.datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%S.%fZ")
    payload = {
        "card_id": card_id,
        "message": message,
        "reported_by": username,
        "reported_date": timestamp,
        "status": "new",
    }
    response = adaboard.request_adaboard(
        path="cardissues",
        method=requests.post,
        json=payload,
    ).json()

    return response["id"]

get_issue_data 

get_issue_data(issue_id)

Get contents and information of a specific issue.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
issue_id int

id of the issue whose info is to be fetched

 required

Returns:

Type Description
dict

dictionary with the issue's detailed info
Source code in adalib/issues/issues.py 
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
def get_issue_data(
    issue_id: int,
) -> dict[
    str,
    int
    | str
    | dict[str, str | int]
    | list[dict[str, int | str | dict[str, int | str]]],
]:
    """
    Get contents and information of a specific issue.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/issues/get_issue_data.ipynb) to test this function or build upon it.

    :param issue_id: id of the issue whose info is to be fetched
    :type issue_id: int
    :return: dictionary with the issue's detailed info
    :rtype: dict
    """

    response = adaboard.request_adaboard(
        path=f"cardissues/{issue_id}", method=requests.get
    ).json()

    return response

get_issues 

get_issues()

Get all the card issues registered in the Gallery.

Use the example Jupyter Notebook to test this function or build upon it.

Returns:

Type Description
list

list of dictionaries with issues' main info
Source code in adalib/issues/issues.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def get_issues() -> list[dict[str, int | str | dict[str, str | int]]]:
    """
    Get all the card issues registered in the Gallery.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/issues/get_issues.ipynb) to test this function or build upon it.

    :return: list of dictionaries with issues' main info
    :rtype: list
    """

    response = adaboard.request_adaboard(
        path="cardissues", method=requests.get
    ).json()

    return response

update_issue 

update_issue(issue_id, new_status='', comment='')

Update issue content (status, comments). Note that only one of the fields can be updated at a time.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
issue_id int

the id of the issue to be updated

 required
new_status str

status to be set

 ''
comment str

comment to be added

 ''

Returns:

Type Description
int

id of the issue update
Source code in adalib/issues/issues.py 
 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
def update_issue(
    issue_id: int, new_status: str = "", comment: str = ""
) -> int:
    """
    Update issue content (status, comments).
    Note that only one of the fields can be updated at a time.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/issues/update_issue.ipynb) to test this function or build upon it.

    :param issue_id: the id of the issue to be updated
    :type issue_id: int
    :param new_status: status to be set
    :type new_status: str
    :param comment: comment to be added
    :type comment: str
    :return: id of the issue update
    :rtype: int
    """

    if comment and not new_status:
        payload = {
            "comment": comment,
            "history_type": "comment",
        }
    elif new_status and not comment:
        assert new_status.lower() in [
            "new",
            "in progress",
            "in_progress",
            "solved",
            "ignored",
        ], "Invalid status!"
        payload = {
            "new_status": new_status.lower().replace(" ", "_"),
            "comment": "",
            "history_type": "new_status",
        }
    else:
        return "Only one field can be updated at a time!"

    response = adaboard.request_adaboard(
        path=f"cardissues/{issue_id}",
        method=requests.put,
        json=payload,
    ).json()

    return response["id"]