[CIVIS-1609] FIX no assert statements in non-test code
#430
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
jacksonlee-civis
commented
Nov 9, 2021
| @@ -17,13 +17,13 @@ This project adheres to [Semantic Versioning](http://semver.org/). | |||
| from `ContainerFuture` to `CivisFuture` (#426) | |||
| - Updated the docstrings for `file_to_civis` (for `buf` and `expires_at`), | |||
| `dataframe_to_file` (for `expires_at`), and `json_to_file` (for `expires_at`). (#427) | |||
| - Added default values from swagger in client method's signature (#416) | |||
There was a problem hiding this comment.
Just cleaning up -- this is a duplicate entry for the same one a couple lines above
jclairelopez
approved these changes
Nov 11, 2021
| @@ -3,6 +3,9 @@ | |||
| from civis._utils import camel_to_snake | |||
|
|
|||
|
|
|||
| _RETURN_TYPES = frozenset({'snake', 'raw', 'pandas'}) | |||
There was a problem hiding this comment.
What are the snake and raw return types? I couldn't figure out what this is. Thanks Jackson!
There was a problem hiding this comment.
It's in the docstring of APICilent:
Lines 352 to 361 in 6c7213e
The default value in APIClient is "snake", since in the Python world you'd expect the attributes to be in snake_case. If you pick "raw" (which I've never used myself in practice), you'd get attributes in camelCase instead.
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.
assertstatements shouldn't be used in the actual, non-test code, since they can be disabled by the-Oflag: https://docs.python.org/3/using/cmdline.html#cmdoption-O It's not clear how likely folks would run Civis-related code with this flag on, but it's better to convert theseassertstatements into conditional statements with exception raising.