Issue #29: Module that retrieves microscope config from Tagarno Open API

[RussellJimmies]

#29

[k-allagbe]

Very clean code overall and does the job. Just few things to improve testability.

Don't forget to unit test your file.

[k-allagbe]

I suggest passing the id to the get_microscope_configuration function as an argument. Then you could do:

if __name__ == "__main__":
    try:
        microscope_id = 6969
        config = get_microscope_configuration(microscope_id)
        if config:
            print(config)
    except OpenApiError as e:
        print(f"Error: {e}")

[RussellJimmies]

It's not the microscope's ID, it's just an int that indentifies the request. As discussed, I'm generating a UUID instead of a hard-coded value.

[k-allagbe]

Got it. In that case, I would create the id on the fly inside the post_request function.
Example:

def post_request(microscope_url, method, headers=HEADERS):
    id = int(uuid.uuid4())
    url = f"{microscope_url}?jsonrpc=2.0&method={method}&id={id}"

    data = json.dumps({
        "jsonrpc": "2.0",
        "method": method,
        "id": id,
    })
...

And if the id's purpose is for verification, then maybe check that the response's id matches.

[k-allagbe]

Also, function parameters are usually lowercase. Same for def get_microscope_configuration(METHODS):. Not a problem per se, but could be confusing.

[rngadam]

looks like this should be a draft for now?

missing unit tests

[MaxenceGui]

Work continue on

• issue #29: Tagarno API documentation and API integration #54