mlco2/codecarbon

API client to throw error instead of None

Open

#820 opened on Apr 13, 2025

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (306 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (1,885 stars)
PR merge metrics
 (PR metrics pending)

Description

The Api client should raise_for_status() instead of None if there is an error. Like this we can call the API client and give a more meaningful error to the user.

Things to consider:

  • The API client should throw but the emissionsTracker should not break, this means that we should try-catch in the emissions tracker.
  • One should check as well if in any of the responses we are if response is None because now they will throw the error

Originally posted by @inimaz in https://github.com/mlco2/codecarbon/issues/798#issuecomment-2800035595

Contributor guide

Research direction
Locate the API client code that returns None on error and change it to raise an exception. Then update the emissionsTracker to catch that exception.
Tech stack
python
Domain
apibackend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75