Examine JSON DataClasses and Remove Optional
for Those That are Required
#317
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.
Proposed changes
Addresses issue: #310
IMPORTANT: This builds on top of this PR: #314 and #316. Do not merge until those PRs are merged.For a cleaner diff between this PR and its dependency #316, please look at this compare for convenience:https://github.com/dvonthenen/deepgram-python-sdk/compare/audit-legacy-v2-syntax...dvonthenen:deepgram-python-sdk:remove-optional-dataclass
IMPORTANT IMPLEMENTATION DETAIL TO REVIEWER/USER: Any parameter on any class that is present when a feature is enabled/disabled, but is missing when a different feature is enabled/disabled, MUST be marked
Optional
and will be omitted from the JSON (that's thefield
/lambda function
stuff you see in the code).If the removal of property isn't done, this is the undesired JSON output that is currently happening:
Making the fields optional as in this PR, yields the following:
Notable changes in this PR:
Option
classes (i.e., the Input options for PreRecorded or Live, for example) are optional since they are only set when needed. Please see above.Optional
, but when the object is present it's properties are required, those properties will be required when looking at the class definition in code. Just explicitly calling this out in order to avoid confusion.Exercised each of the
examples
and made sure the expected values were there.Types of changes
What types of changes does your code introduce to the community Python SDK?
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments