Skip to content

fix: Use default_batch_size for enhanced_search_issues #2377

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Use default_batch_size for enhanced_search_issues #2377

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 10 additions & 11 deletions jira/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -918,7 +918,7 @@ def _fetch_pages_searchToken(
item_type: type[ResourceType],
items_key: str | None,
request_path: str,
maxResults: int = 50,
maxResults: int | Literal[False] = 50,
params: dict[str, Any] | None = None,
base: str = JIRA_BASE_URL,
use_post: bool = False,
Expand All @@ -929,19 +929,18 @@ def _fetch_pages_searchToken(
item_type (Type[Resource]): Type of single item. Returns a `ResultList` of such items.
items_key (Optional[str]): Path to the items in JSON returned from the server.
request_path (str): Path in the request URL.
maxResults (int): Maximum number of items to return per page. (Default: 50)
maxResults (int): Maximum number of items to return. If maxResults evaluates as False, it will try to get all items in batches. (Default:50)
params (Dict[str, Any]): Parameters to be sent with the request.
base (str): Base URL for the requests.
use_post (bool): Whether to use POST instead of GET.

Returns:
ResultList: List of fetched items.
"""
DEFAULT_BATCH = 100 # Max batch size per request
fetch_all = maxResults in (0, False) # If False/0, fetch everything

page_params = (params or {}).copy() # Ensure params isn't modified
page_params["maxResults"] = DEFAULT_BATCH if fetch_all else maxResults
page_params["maxResults"] = self._get_batch_size(item_type) if fetch_all else maxResults

# Use caller-provided nextPageToken if present
nextPageToken: str | None = page_params.get("nextPageToken")
Expand Down Expand Up @@ -2177,7 +2176,7 @@ def createmeta_fieldtypes(
projectIdOrKey: str | int,
issueTypeId: str | int,
startAt: int = 0,
maxResults: int = 50,
maxResults: int | Literal[False] = 50,
) -> dict[str, Any]:
"""Get the field metadata for a given project and issue type, required to create issues.

Expand Down Expand Up @@ -3091,7 +3090,7 @@ def project_issue_types(
self,
project: str,
startAt: int = 0,
maxResults: int = 50,
maxResults: int | Literal[False] = 50,
) -> ResultList[IssueType]:
"""Get a list of issue type Resources available in a given project from the server.

Expand Down Expand Up @@ -3121,7 +3120,7 @@ def project_issue_fields(
project: str,
issue_type: str,
startAt: int = 0,
maxResults: int = 50,
maxResults: int | Literal[False] = 50,
) -> ResultList[Field]:
"""Get a list of field type Resources available for a project and issue type from the server.

Expand Down Expand Up @@ -3557,7 +3556,7 @@ def search_issues(
self,
jql_str: str,
startAt: int = 0,
maxResults: int = 50,
maxResults: int | Literal[False] = 50,
validate_query: bool = True,
fields: str | list[str] | None = "*all",
expand: str | None = None,
Expand All @@ -3572,7 +3571,7 @@ def search_issues(
self,
jql_str: str,
startAt: int = 0,
maxResults: int = 50,
maxResults: int | Literal[False] = 50,
validate_query: bool = True,
fields: str | list[str] | None = "*all",
expand: str | None = None,
Expand All @@ -3586,7 +3585,7 @@ def search_issues(
self,
jql_str: str,
startAt: int = 0,
maxResults: int = 50,
maxResults: int | Literal[False] = 50,
validate_query: bool = True,
fields: str | list[str] | None = "*all",
expand: str | None = None,
Expand Down Expand Up @@ -3693,7 +3692,7 @@ def enhanced_search_issues(
self,
jql_str: str,
nextPageToken: str | None = None,
maxResults: int = 50,
maxResults: int | Literal[False] = 50,
fields: str | list[str] | None = "*all",
expand: str | None = None,
reconcileIssues: list[int] | None = None,
Expand Down