Skip to content

Add include_history parameter to Client search method #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gmorales96 wants to merge 4 commits into
base: master
Choose a base branch
from
+5 −1
Open

Add include_history parameter to Client search method #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6da1f07
Add include_history parameter to Client search method
gmorales96 Jan 28, 2026
9fc630f
Add vcrpy dependency to requirements-test.txt
gmorales96 Jan 28, 2026
65b7a0b
Bump version to 1.0.4
gmorales96 Jan 28, 2026
06df3ff
Update README to clarify include_history parameter behavior in Client…
gmorales96 Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ client = Client(
- `search_type` (SearchType): fisica or moral.
- `search_list` (tuple[SearchList, ...]): Lists to search.
If not provided, searches all.
- `include_history` (bool | None): If `True`, include historical records; if `False`, only current; if `None`, use API default.

The search follows a hierarchical approach: it first attempts to find a match using the RFC.
If no match is found, it searches by CURP. Finally, if neither is found, it looks for a match by name.
Expand Down
2 changes: 2 additions & 0 deletions quienesquien/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ async def search(
birthday: dt.date | None = None,
search_type: SearchType | None = None,
search_list: tuple[SearchList, ...] | None = None,
include_history: bool | None = None,
Copy link

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The codebase has comprehensive test coverage for the search method with various parameters (see tests/test_client.py lines 24-61), but no tests have been added for the new include_history parameter. Consider adding test cases that verify the behavior when include_history is set to True, False, and None to ensure the parameter is correctly passed to the API and behaves as expected.

Copilot uses AI. Check for mistakes.
) -> list[Person]:
"""Perform a search request and return the results.

Expand Down Expand Up @@ -105,6 +106,7 @@ async def search(
'birthday': birthday.strftime('%d/%m/%Y') if birthday else None,
'type': search_type.value if search_type is not None else None,
'list': ','.join(search_list) if search_list else None,
'include_history': include_history,
Copy link

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When a Python boolean (True/False) is passed as a query parameter through httpx, it will be serialized as the capitalized string "True" or "False". Many REST APIs expect lowercase "true"/"false" or numeric "1"/"0" values for boolean parameters. You should verify that the API accepts "True"/"False" strings, or convert the boolean to the expected format. For example, you could use str(include_history).lower() if the API expects lowercase, or implement a converter function that maps True->1 and False->0 if the API expects numeric values.

Suggested change
'include_history': include_history,
'include_history': str(include_history).lower() if include_history is not None else None,

Copilot uses AI. Check for mistakes.
}

params = {k: v for k, v in params.items() if v is not None}
Expand Down
2 changes: 1 addition & 1 deletion quienesquien/version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.0.3'
__version__ = '1.0.4'
1 change: 1 addition & 0 deletions requirements-test.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ types-requests==2.*
pytest-asyncio==0.*
pytest-mock==3.*
respx==0.*
vcrpy==7.0.*
Loading