Skip to content

Add new args for export records #223

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

Merged
pwildenhain merged 4 commits into from
Mar 31, 2022
Merged

Add new args for export records #223

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
438808e
:recycle: Move filter_logic param into optional params loop
pwildenhain Mar 31, 2022
c06d118
:sparkles: Add decimal_character to export_records
pwildenhain Mar 31, 2022
b908633
:sparkles: Add export_blank_for_gray_form_status to export_records
pwildenhain Mar 31, 2022
4e990fa
:arrow_down: Move df_kwargs to end of arg list for export_records
pwildenhain Mar 31, 2022
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
39 changes: 27 additions & 12 deletions redcap/methods/records.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,13 @@ def export_records(
record_type: Literal["flat", "eav"] = "flat",
export_survey_fields: bool = False,
export_data_access_groups: bool = False,
df_kwargs: Optional[Dict[str, Any]] = None,
export_checkbox_labels: bool = False,
filter_logic: Optional[str] = None,
date_begin: Optional[datetime] = None,
date_end: Optional[datetime] = None,
decimal_character: Optional[Literal[",", "."]] = None,
export_blank_for_gray_form_status: Optional[bool] = None,
df_kwargs: Optional[Dict[str, Any]] = None,
) -> Json:
...

Expand All @@ -49,11 +51,13 @@ def export_records(
record_type: Literal["flat", "eav"] = "flat",
export_survey_fields: bool = False,
export_data_access_groups: bool = False,
df_kwargs: Optional[Dict[str, Any]] = None,
export_checkbox_labels: bool = False,
filter_logic: Optional[str] = None,
date_begin: Optional[datetime] = None,
date_end: Optional[datetime] = None,
decimal_character: Optional[Literal[",", "."]] = None,
export_blank_for_gray_form_status: Optional[bool] = None,
df_kwargs: Optional[Dict[str, Any]] = None,
) -> str:
...

Expand All @@ -71,11 +75,13 @@ def export_records(
record_type: Literal["flat", "eav"] = "flat",
export_survey_fields: bool = False,
export_data_access_groups: bool = False,
df_kwargs: Optional[Dict[str, Any]] = None,
export_checkbox_labels: bool = False,
filter_logic: Optional[str] = None,
date_begin: Optional[datetime] = None,
date_end: Optional[datetime] = None,
decimal_character: Optional[Literal[",", "."]] = None,
export_blank_for_gray_form_status: Optional[bool] = None,
df_kwargs: Optional[Dict[str, Any]] = None,
) -> "pd.DataFrame":
...

Expand All @@ -92,11 +98,13 @@ def export_records(
record_type: Literal["flat", "eav"] = "flat",
export_survey_fields: bool = False,
export_data_access_groups: bool = False,
df_kwargs: Optional[Dict[str, Any]] = None,
export_checkbox_labels: bool = False,
filter_logic: Optional[str] = None,
date_begin: Optional[datetime] = None,
date_end: Optional[datetime] = None,
decimal_character: Optional[Literal[",", "."]] = None,
export_blank_for_gray_form_status: Optional[bool] = None,
df_kwargs: Optional[Dict[str, Any]] = None,
):
# pylint: disable=line-too-long
"""
Expand Down Expand Up @@ -146,10 +154,6 @@ def export_records(
being used to make the API request is *not* in a data
access group. If the user is in a group, then this flag
will revert to its default value.
df_kwargs:
Passed to `pandas.read_csv` to control construction of
returned DataFrame.
By default, `{'index_col': self.def_field}`
export_checkbox_labels:
Specify whether to export checkbox values as their label on
export.
Expand All @@ -159,7 +163,15 @@ def export_records(
Filter on records created after a date
date_end:
Filter on records created before a date

decimal_character:
Force all numbers into same decimal format
export_blank_for_gray_form_status:
Whether or not to export blank values for instrument complete status fields
that have a gray status icon
df_kwargs:
Passed to `pandas.read_csv` to control construction of
returned DataFrame.
By default, `{'index_col': self.def_field}`
Returns:
Union[List[Dict[str, Any]], str, pd.DataFrame]: Exported data

Expand Down Expand Up @@ -211,6 +223,9 @@ def export_records(
export_survey_fields,
export_data_access_groups,
export_checkbox_labels,
filter_logic,
decimal_character,
export_blank_for_gray_form_status,
)

str_keys = (
Expand All @@ -224,6 +239,9 @@ def export_records(
"exportSurveyFields",
"exportDataAccessGroups",
"exportCheckboxLabel",
"filterLogic",
"decimalCharacter",
"exportBlankForGrayFormStatus",
)

for key, data in zip(str_keys, keys_to_add):
Expand All @@ -240,9 +258,6 @@ def export_records(
if date_end:
payload["dateRangeEnd"] = date_end.strftime("%Y-%m-%d %H:%M:%S")

if filter_logic:
payload["filterLogic"] = filter_logic

return_type = self._lookup_return_type(format_type, request_type="export")
response = self._call_api(payload, return_type)

Expand Down