MHPY-15 fragment creation #10
Merged
Conversation
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
According to the MediaHaven REST API, a POST response can have a different status than 200 or 204, depending on the resource. For example, creating a record returns a 201 (Created). For simplicity reasons, just accept everything between the 200 and 207 range including the boundaries. Also, adapt the docstring to reflect the reality.
Rename `parent_record_id` to `record_id` and make it the first parameter to be more consistent with the other methods. Adapt docstring to reflect the truth. Autoformat with black. Also, bump black version to fix autoformat on save in VSCode.
According to the Python documentation:
"Passing arguments of the wrong type (e.g. passing a list when an int is expected)
should result in a TypeError, but passing arguments with the wrong value
(e.g. a number outside expected boundaries) should result in a ValueError."
More specifically for ValueError:
"Raised when an operation or function receives an argument that has the right type
but an inappropriate value, and the situation is not described by a more precise
exception such as IndexError."
Raising a ValueError is more appropriate in this case.
Add tests for `Records.create`. Add type hints for frames and timecode arguments in the `Records.create` function. Change response of `MediaHavenClient._post` to actually return the content of the body if there is any. Depending on the resource (path), the response can contain content, for example a post request on the resource `exports`, returns information of the created export. Change `media_id` to `record_id` to reflect the signature and/or API path.
spacid
approved these changes
Jun 2, 2023
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.
No description provided.