FIX/strike_limit typed as float causes API requests to fail#28
Open
MarketDataDev03 wants to merge 1 commit into
Open
FIX/strike_limit typed as float causes API requests to fail#28MarketDataDev03 wants to merge 1 commit into
strike_limit typed as float causes API requests to fail#28MarketDataDev03 wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #28 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 52 52
Lines 2281 2281
=========================================
Hits 2281 2281
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
strike_limit typed as float causes API requests to failstrike_limit typed as float causes API requests to fail
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
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.
Fix:
strike_limittyped asfloatcauses API requests to failCloses #24
Summary
options.chain(..., strike_limit=10)failed becausestrike_limitwas annotatedas
float | None. Pydantic (lax mode) coerced the integer10to10.0, whichwas then serialized into the request URL as
strikeLimit=10.0— a value the APIrejects, since
strike_limitis a count of strikes, not a price.This PR changes the field's type to
int | Noneso integer inputs stay integerson the wire, and updates the documentation accordingly.
Problem
Root cause —
src/marketdata/input_types/options.py:67:Changes
src/marketdata/input_types/options.pyWith
int | None, Pydantic keeps10as10, and_build_urlserializes itinto
strikeLimit=10.docs/options.mdTesting
Two new tests in
src/tests/test_options_chain.py, covering the bug at twolevels:
test_options_chain_input_strike_limit_typed_as_int— unit test on theinput model. Asserts that
OptionsChainInput(strike_limit=10).strike_limitiskept as an
int(type(...) is int), not coerced to afloat.test_options_chain_strike_limit_is_int_on_wire— integration test thatinspects the actual outgoing request via
respx_mock.calls.last.request.url.paramsand assertsparams["strikeLimit"] == "10"(not"10.0"). Mirrors the existingtest_options_chain_input_date_range_aliases_on_wirepattern.Developed with a TDD red → green cycle.
Full suite green — no regressions.
Files changed
src/marketdata/input_types/options.pystrike_limitretypedfloat | None→int | Nonedocs/options.mdintsrc/tests/test_options_chain.py