Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (11)
📝 WalkthroughWalkthroughAdds a new Stats API client and models for retrieving aggregated sending statistics, wire-up in the main client, list-serialization support for query params, example usage, changelog/README updates, and comprehensive unit tests. Changes
Sequence DiagramsequenceDiagram
participant Client as MailtrapClient
participant StatsApi as StatsApi
participant HttpClient as HttpClient
participant Server as API Server
participant Parser as Response Parser
Client->>StatsApi: get(account_id, params)
StatsApi->>StatsApi: _base_path(account_id)
StatsApi->>StatsApi: api_query_params (serialize lists)
StatsApi->>HttpClient: GET /api/accounts/{id}/stats?params
HttpClient->>Server: HTTP GET Request
Server-->>HttpClient: JSON Response
HttpClient-->>StatsApi: Response JSON
StatsApi->>Parser: SendingStats(**response)
Parser-->>StatsApi: SendingStats instance
StatsApi-->>Client: SendingStats
Client->>StatsApi: by_domain(account_id, params)
StatsApi->>HttpClient: GET /api/accounts/{id}/stats/domains?params
HttpClient->>Server: HTTP GET Request
Server-->>HttpClient: JSON Response (grouped items)
HttpClient-->>StatsApi: Response JSON
StatsApi->>Parser: [SendingStatGroup(...) for item in response]
Parser-->>StatsApi: list[SendingStatGroup]
StatsApi-->>Client: Grouped stats list
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
examples/general/stats.py (1)
1-4: Consider consolidating imports.The three imports from
mailtrap.models.statscan be combined into a single line for brevity.Proposed fix
import mailtrap as mt -from mailtrap.models.stats import SendingStatGroup -from mailtrap.models.stats import SendingStats -from mailtrap.models.stats import StatsFilterParams +from mailtrap.models.stats import SendingStatGroup, SendingStats, StatsFilterParams🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/general/stats.py` around lines 1 - 4, Consolidate the three separate imports from mailtrap.models.stats into a single statement: replace the three lines importing SendingStatGroup, SendingStats, and StatsFilterParams with one combined import that lists those symbols together (keep the existing import mailtrap as mt intact); ensure the combined import includes SendingStatGroup, SendingStats, and StatsFilterParams exactly as named.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@examples/general/stats.py`:
- Around line 6-7: The example defines ACCOUNT_ID as a string while helper
functions expect account_id: int; update the example to provide an integer
ACCOUNT_ID (replace "YOUR_ACCOUNT_ID" with a numeric literal) or explicitly
cast/convert it before passing to functions so the value matches the account_id:
int signatures (look for the ACCOUNT_ID constant and any functions/methods that
declare account_id: int).
In `@mailtrap/api/resources/stats.py`:
- Around line 18-39: Reformat the oversized function signatures and long calls
in this file to satisfy Black/E501: wrap long parameter lists and chained calls
for the methods get, by_domains, by_categories, by_email_service_providers, and
by_date so no line exceeds the max width; specifically break the signature and
the return/_grouped_stats call lines that pass StatsFilterParams (e.g., the
by_email_service_providers(...) -> return self._grouped_stats(...)) across
multiple lines consistent with Black's style, then run Black on
mailtrap/api/resources/stats.py to ensure CI passes.
In `@mailtrap/models/stats.py`:
- Around line 31-33: The StatsFilterParams class uses empty-string defaults for
start_date/end_date causing RequestParams.api_data(..., exclude_none=True) to
still serialize them; change both fields in StatsFilterParams to use
Optional[str] with default None (and add the typing import if missing) so when
unset they are omitted from api_data serialization; update any related
validation or consumers that expect empty strings to handle None instead.
In `@tests/unit/api/general/test_stats.py`:
- Line 146: The test function signature for test_get_with_filter_params is too
long and must be wrapped to satisfy line-length rules; edit the def
test_get_with_filter_params(self, client: StatsApi, sample_stats_dict: dict) ->
None: signature to break parameters across multiple lines (e.g., place each
parameter on its own line or use a hanging indent inside the def parentheses) so
the line length is under the configured limit, then re-run/commit Black (or run
the project's formatter) to ensure the file passes CI formatting checks.
---
Nitpick comments:
In `@examples/general/stats.py`:
- Around line 1-4: Consolidate the three separate imports from
mailtrap.models.stats into a single statement: replace the three lines importing
SendingStatGroup, SendingStats, and StatsFilterParams with one combined import
that lists those symbols together (keep the existing import mailtrap as mt
intact); ensure the combined import includes SendingStatGroup, SendingStats, and
StatsFilterParams exactly as named.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c0ad3c1f-6b85-4473-a950-b27b381aec46
📒 Files selected for processing (9)
CHANGELOG.mdexamples/general/stats.pymailtrap/__init__.pymailtrap/api/general.pymailtrap/api/resources/stats.pymailtrap/models/common.pymailtrap/models/stats.pypyproject.tomltests/unit/api/general/test_stats.py
piobeny
force-pushed
the
stats-api
branch
3 times, most recently
from
5bbca85 to
a8a254b
Compare
piobeny
force-pushed
the
stats-api
branch
2 times, most recently
from
908dbe5 to
72004fc
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
tests/unit/api/general/test_stats.py (1)
145-169: Cover scalar filters and the “unset params are omitted” case too.This test locks in the list serialization, but it still misses the other half of the contract:
start_date/end_datebeing sent under the expected keys, andStatsFilterParams()omitting unset fields entirely. Adding those assertions here would make regressions inRequestParams.api_data(..., exclude_none=True)much easier to catch.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@examples/general/stats.py`:
- Around line 1-2: The import block in examples/general/stats.py was reordered
by the project's isort pre-commit hook and must be committed to pass CI; run
your local import formatter (isort) or the project's pre-commit hooks against
this file, accept the rewritten import ordering (affecting the top-level import
"mailtrap as mt" and the from-import of SendingStatGroup, SendingStats,
StatsFilterParams from mailtrap.models.stats), and commit the resulting changes
so the file matches the repo's canonical import ordering.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 4782846c-b227-4e63-b0b8-0be945578cf9
📒 Files selected for processing (9)
CHANGELOG.mdexamples/general/stats.pymailtrap/__init__.pymailtrap/api/general.pymailtrap/api/resources/stats.pymailtrap/models/common.pymailtrap/models/stats.pypyproject.tomltests/unit/api/general/test_stats.py
🚧 Files skipped from review as they are similar to previous changes (5)
- mailtrap/init.py
- mailtrap/models/common.py
- CHANGELOG.md
- mailtrap/api/resources/stats.py
- pyproject.toml
Contributor
Author
|
@mklocek it's same but wanted to have another PR for version release |
mklocek
approved these changes
Mar 10, 2026
mklocek
reviewed
Mar 16, 2026
mailtrap/api/general.py
Outdated
|
|
||
| @property | ||
| def stats(self) -> StatsApi: | ||
| return StatsApi(client=self._client) |
Contributor
There was a problem hiding this comment.
Similar like in other SDKs, I would move it outside "general" namespace
IgorDobryn
approved these changes
Mar 23, 2026
piobeny
force-pushed
the
stats-api
branch
2 times, most recently
from
b15fa11 to
8351152
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
examples/stats/stats.py (1)
13-35: Consider extracting default date params to a helper.The same date-range construction repeats across multiple functions; a small helper would reduce duplication in this example.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/stats/stats.py` around lines 13 - 35, The repeated StatsFilterParams(start_date="2026-01-01", end_date="2026-01-31") should be extracted into a small helper (e.g., make_default_stats_params or build_stats_params) and then used by get_stats, get_stats_by_domain, get_stats_by_category, get_stats_by_email_service_provider, and get_stats_by_date so each function passes the helper's return value into stats_api.get / stats_api.by_domain / stats_api.by_category / stats_api.by_email_service_provider / stats_api.by_date; implement the helper near the top of the file and replace the duplicated constructions with a single call to that helper.mailtrap/models/common.py (1)
23-27: Avoid mutating theapi_dataobject in place.Line 23 currently reuses
self.api_dataand then mutates it withpop. A defensive copy prevents accidental side effects if any subclass returns a reused dict.♻️ Proposed refactor
`@property` def api_query_params(self: T) -> dict[str, Any]: - data = self.api_data + data = dict(self.api_data) for key, value in list(data.items()): if isinstance(value, list): data[f"{key}[]"] = data.pop(key) return data🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@mailtrap/models/common.py` around lines 23 - 27, The method currently assigns data = self.api_data and mutates it with pop, which can cause side effects; instead create a shallow copy (e.g., data = dict(self.api_data) or self.api_data.copy()) or build a new dict, iterate over the original to detect list values and add keys like f"{key}[]" to the copy without calling pop on the original, then return the copied/constructed dict; reference the api_data attribute and the loop that checks isinstance(value, list) to locate where to change the mutation.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@examples/stats/stats.py`:
- Around line 6-10: Replace hard-coded credentials with environment variables:
stop using the token literal API_TOKEN and numeric ACCOUNT_ID in the example and
instead read them from the environment (e.g., using os.getenv/os.environ.get)
before constructing mt.MailtrapClient and accessing stats_api; validate that the
token exists and raise a clear error or exit if it’s missing so accidental
commits don’t include credentials, and reference the symbols API_TOKEN,
ACCOUNT_ID, and mt.MailtrapClient to locate and update the example.
---
Nitpick comments:
In `@examples/stats/stats.py`:
- Around line 13-35: The repeated StatsFilterParams(start_date="2026-01-01",
end_date="2026-01-31") should be extracted into a small helper (e.g.,
make_default_stats_params or build_stats_params) and then used by get_stats,
get_stats_by_domain, get_stats_by_category, get_stats_by_email_service_provider,
and get_stats_by_date so each function passes the helper's return value into
stats_api.get / stats_api.by_domain / stats_api.by_category /
stats_api.by_email_service_provider / stats_api.by_date; implement the helper
near the top of the file and replace the duplicated constructions with a single
call to that helper.
In `@mailtrap/models/common.py`:
- Around line 23-27: The method currently assigns data = self.api_data and
mutates it with pop, which can cause side effects; instead create a shallow copy
(e.g., data = dict(self.api_data) or self.api_data.copy()) or build a new dict,
iterate over the original to detect list values and add keys like f"{key}[]" to
the copy without calling pop on the original, then return the copied/constructed
dict; reference the api_data attribute and the loop that checks
isinstance(value, list) to locate where to change the mutation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c6cd02c2-1a11-47c3-ab19-d811cd418c42
📒 Files selected for processing (11)
CHANGELOG.mdREADME.mdexamples/stats/stats.pymailtrap/__init__.pymailtrap/api/general.pymailtrap/api/resources/stats.pymailtrap/client.pymailtrap/models/common.pymailtrap/models/stats.pypyproject.tomltests/unit/api/test_stats.py
✅ Files skipped from review due to trivial changes (6)
- mailtrap/api/general.py
- mailtrap/init.py
- pyproject.toml
- CHANGELOG.md
- README.md
- mailtrap/api/resources/stats.py
🚧 Files skipped from review as they are similar to previous changes (1)
- mailtrap/models/stats.py
Comment on lines
+6
to
+10
| API_TOKEN = "YOUR_API_TOKEN" | ||
| ACCOUNT_ID = 123456 | ||
|
|
||
| client = mt.MailtrapClient(token=API_TOKEN) | ||
| stats_api = client.stats_api |
There was a problem hiding this comment.
Use environment variables for credentials in the example.
Line 6 uses a token literal, which triggers security lint and can normalize unsafe copy/paste patterns. Prefer env vars for both token and account id.
🔐 Proposed fix
+import os
import mailtrap as mt
from mailtrap.models.stats import SendingStatGroup
from mailtrap.models.stats import SendingStats
from mailtrap.models.stats import StatsFilterParams
-API_TOKEN = "YOUR_API_TOKEN"
-ACCOUNT_ID = 123456
+API_TOKEN = os.environ["MAILTRAP_API_TOKEN"]
+ACCOUNT_ID = int(os.environ["MAILTRAP_ACCOUNT_ID"])
client = mt.MailtrapClient(token=API_TOKEN)
stats_api = client.stats_api🧰 Tools
🪛 Ruff (0.15.6)
[error] 6-6: Possible hardcoded password assigned to: "API_TOKEN"
(S105)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/stats/stats.py` around lines 6 - 10, Replace hard-coded credentials
with environment variables: stop using the token literal API_TOKEN and numeric
ACCOUNT_ID in the example and instead read them from the environment (e.g.,
using os.getenv/os.environ.get) before constructing mt.MailtrapClient and
accessing stats_api; validate that the token exists and raise a clear error or
exit if it’s missing so accidental commits don’t include credentials, and
reference the symbols API_TOKEN, ACCOUNT_ID, and mt.MailtrapClient to locate and
update the example.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@examples/stats/stats.py`:
- Line 7: ACCOUNT_ID is defined as a string but the example functions expect
account_id: int; change the placeholder for ACCOUNT_ID from "YOUR_ACCOUNT_ID" to
an integer placeholder (e.g., 12345) and update any other similar placeholders
at the mentioned locations so they match the annotated parameter type for
functions that accept account_id (look for occurrences of account_id: int in the
example functions and the constant ACCOUNT_ID).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: cabea9d3-d065-4a5b-af39-dd13a4b61ac1
📒 Files selected for processing (11)
CHANGELOG.mdREADME.mdexamples/stats/stats.pymailtrap/__init__.pymailtrap/api/general.pymailtrap/api/resources/stats.pymailtrap/client.pymailtrap/models/common.pymailtrap/models/stats.pypyproject.tomltests/unit/api/test_stats.py
✅ Files skipped from review due to trivial changes (8)
- mailtrap/api/general.py
- README.md
- mailtrap/init.py
- pyproject.toml
- CHANGELOG.md
- tests/unit/api/test_stats.py
- mailtrap/api/resources/stats.py
- mailtrap/models/stats.py
🚧 Files skipped from review as they are similar to previous changes (1)
- mailtrap/models/common.py
| from mailtrap.models.stats import StatsFilterParams | ||
|
|
||
| API_TOKEN = "YOUR_API_TOKEN" | ||
| ACCOUNT_ID = "YOUR_ACCOUNT_ID" |
There was a problem hiding this comment.
Type mismatch between ACCOUNT_ID and function signatures.
ACCOUNT_ID is declared as a string ("YOUR_ACCOUNT_ID"), but all functions annotate account_id: int. This inconsistency could confuse users copying the example.
🐛 Proposed fix — use an integer placeholder
-ACCOUNT_ID = "YOUR_ACCOUNT_ID"
+ACCOUNT_ID = 123456 # Replace with your account IDAlso applies to: 13-13, 61-61
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/stats/stats.py` at line 7, ACCOUNT_ID is defined as a string but the
example functions expect account_id: int; change the placeholder for ACCOUNT_ID
from "YOUR_ACCOUNT_ID" to an integer placeholder (e.g., 12345) and update any
other similar placeholders at the mentioned locations so they match the
annotated parameter type for functions that accept account_id (look for
occurrences of account_id: int in the example functions and the constant
ACCOUNT_ID).
a6ee126 to
aeb6125
Compare
piobeny
commented
Mar 23, 2026
Comment on lines
+24
to
+34
| include: | ||
| - python: "3.9" | ||
| tox-env: "py39" | ||
| - python: "3.10" | ||
| tox-env: "py310" | ||
| - python: "3.11" | ||
| tox-env: "py311" | ||
| - python: "3.12" | ||
| tox-env: "py312" | ||
| - python: "3.13" | ||
| tox-env: "py313" |
Contributor
Author
There was a problem hiding this comment.
it's needed as new tox version is not accepting previous format:
Contributor
Author
|
@mklocek can you take another look? I added fix for our pipeline and move stats out of general API |
mklocek
approved these changes
Mar 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Changes
How to test
Examples
Summary by CodeRabbit
New Features
Documentation
Tests