feat: add draft status to Response
#3033
Merged
Conversation
This file contains 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
gabrielmbmb
added
type: enhancement
|
I'll update some unit tests that I've missed from |
updates: - [github.com/charliermarsh/ruff-pre-commit: v0.0.269 → v0.0.270](astral-sh/ruff-pre-commit@v0.0.269...v0.0.270)
gabrielmbmb
force-pushed
the
feat/response-status-draft
branch
from
5b42ba3 to
38f4e2d
Compare
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## develop #3033 +/- ##
===========================================
- Coverage 90.81% 90.81% -0.01%
===========================================
Files 208 208
Lines 11181 11179 -2
===========================================
- Hits 10154 10152 -2
Misses 1027 1027
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
frascuchon
reviewed
Jun 1, 2023
tests/server/api/v1/test_records.py
Outdated
| @@ -101,7 +101,7 @@ def create_multi_label_selection_questions(dataset: "Dataset") -> None: | |||
| ), | |||
| ], | |||
| ) | |||
| def test_create_record_response( | |||
| def test_create_record_response_with_valid_values( | |||
There was a problem hiding this comment.
Regarding the new test name, we should parameterize also the status and create responses with partial values (this is a difference between submitted and draft)
frascuchon
reviewed
Jun 1, 2023
frascuchon
approved these changes
Jun 2, 2023
davidberenstein1957
pushed a commit
that referenced
this pull request
Jun 5, 2023
# Description I've added a new possible status for the `Response` model called `draft`. As this is a new possible status, I've also updated the `GET /api/v1/me/datasets/:dataset_id/metrics` endpoint to return also the count of responses with their status equal to `draft`. In addition, I've removed the `SubmittedResponseCreate` and `DiscardedResponseCreate` classes and the discriminated union in which they were being used (`ResponseCreate`), and instead I've created a `pydantic.BaseModel` class called `ResponseCreate`. Also, I've refactored the functions for getting the count of the responses based on their status: - `count_responses_by_dataset_id_and_user_id` now accepts an optional `response_status` argument - `count_submitted_responses_by_dataset_id_and_user_id` and `count_discarded_responses_by_dataset_id_and_user_id` have been removed. Finally, I've updated the unit tests for the endpoints `GET /api/v1/me/datasets/:dataset_id/metrics`, `GET /api/v1/me/datasets/:dataset_id/records` and `POST /api/v1/records/:record_id/responses`. Closes #3008 **Type of change** - [x] New feature (non-breaking change which adds functionality) - [x] Refactor **How Has This Been Tested** All the relevant unit tests for these changes have been updated and re-executed. **Checklist** - [x] I have merged the original branch into my forked branch - [ ] I added relevant documentation - [x] follows the style guidelines of this project - [x] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Francisco Aranda <[email protected]>
7 tasks
davidberenstein1957
pushed a commit
that referenced
this pull request
Jun 7, 2023
# Description I've added a new possible status for the `Response` model called `draft`. As this is a new possible status, I've also updated the `GET /api/v1/me/datasets/:dataset_id/metrics` endpoint to return also the count of responses with their status equal to `draft`. In addition, I've removed the `SubmittedResponseCreate` and `DiscardedResponseCreate` classes and the discriminated union in which they were being used (`ResponseCreate`), and instead I've created a `pydantic.BaseModel` class called `ResponseCreate`. Also, I've refactored the functions for getting the count of the responses based on their status: - `count_responses_by_dataset_id_and_user_id` now accepts an optional `response_status` argument - `count_submitted_responses_by_dataset_id_and_user_id` and `count_discarded_responses_by_dataset_id_and_user_id` have been removed. Finally, I've updated the unit tests for the endpoints `GET /api/v1/me/datasets/:dataset_id/metrics`, `GET /api/v1/me/datasets/:dataset_id/records` and `POST /api/v1/records/:record_id/responses`. Closes #3008 **Type of change** - [x] New feature (non-breaking change which adds functionality) - [x] Refactor **How Has This Been Tested** All the relevant unit tests for these changes have been updated and re-executed. **Checklist** - [x] I have merged the original branch into my forked branch - [ ] I added relevant documentation - [x] follows the style guidelines of this project - [x] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Francisco Aranda <[email protected]>
12 tasks
alvarobartt
added a commit
that referenced
this pull request
Sep 14, 2023
# Description This PR replaces the pre-defined `Literal`s for the response status in both the Python SDK and the Python client, so as to use an `Enum` instead. Besides that, also the `draft` status has been included as it was previously missing, but as of #3033 it was included in the API and as of #3541 it was also included in the UI. Closes #3745 **Type of change** - [X] Bug fix (non-breaking change which fixes an issue) - [X] Improvement (change adding some improvement to an existing functionality) **How Has This Been Tested** (Please describe the tests that you ran to verify your changes. And ideally, reference `tests`) - [X] Added `draft` as another use-case of the `ResponseSchema` unit tests - [x] Added responses with `draft` status in `from_argilla` integration tests **Checklist** - [ ] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [X] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [x] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
I've added a new possible status for the
Responsemodel calleddraft. As this is a new possible status, I've also updated theGET /api/v1/me/datasets/:dataset_id/metricsendpoint to return also the count of responses with their status equal todraft.In addition, I've removed the
SubmittedResponseCreateandDiscardedResponseCreateclasses and the discriminated union in which they were being used (ResponseCreate), and instead I've created apydantic.BaseModelclass calledResponseCreate.Also, I've refactored the functions for getting the count of the responses based on their status:
count_responses_by_dataset_id_and_user_idnow accepts an optionalresponse_statusargumentcount_submitted_responses_by_dataset_id_and_user_idandcount_discarded_responses_by_dataset_id_and_user_idhave been removed.Finally, I've updated the unit tests for the endpoints
GET /api/v1/me/datasets/:dataset_id/metrics,GET /api/v1/me/datasets/:dataset_id/recordsandPOST /api/v1/records/:record_id/responses.Closes #3008
Type of change
How Has This Been Tested
All the relevant unit tests for these changes have been updated and re-executed.
Checklist