Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BugFix] Ad 'x-' to json_schema_extra in Fields with unit_measurement #6376

Merged
merged 4 commits into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -33,65 +33,65 @@ class TreasuryRatesData(Data):
week_4: Optional[float] = Field(
default=None,
description="4 week Treasury bills rate (secondary market).",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
month_1: Optional[float] = Field(
description="1 month Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
month_2: Optional[float] = Field(
description="2 month Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
month_3: Optional[float] = Field(
description="3 month Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
month_6: Optional[float] = Field(
description="6 month Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
year_1: Optional[float] = Field(
description="1 year Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
year_2: Optional[float] = Field(
description="2 year Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
year_3: Optional[float] = Field(
description="3 year Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
year_5: Optional[float] = Field(
description="5 year Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
year_7: Optional[float] = Field(
description="7 year Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
year_10: Optional[float] = Field(
description="10 year Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
year_20: Optional[float] = Field(
description="20 year Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
year_30: Optional[float] = Field(
description="30 year Treasury rate.",
default=None,
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
Original file line number Diff line number Diff line change
Expand Up @@ -90,19 +90,19 @@ class BenzingaAnalystSearchData(AnalystSearchData):
overall_success_rate: Optional[float] = Field(
default=None,
description="The percentage (normalized) of gain/loss ratings that resulted in a gain overall.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
overall_avg_return_percentile: Optional[float] = Field(
default=None,
description="The percentile (normalized) of this analyst's overall average"
+ " return per rating in comparison to other analysts' overall average returns per rating.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
total_ratings_percentile: Optional[float] = Field(
default=None,
description="The percentile (normalized) of this analyst's total number of ratings"
+ " in comparison to the total number of ratings published by all other analysts",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
total_ratings: Optional[int] = Field(
default=None,
Expand All @@ -119,13 +119,13 @@ class BenzingaAnalystSearchData(AnalystSearchData):
overall_average_return: Optional[float] = Field(
default=None,
description="The average percent (normalized) price difference per rating since the date of recommendation",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
overall_std_dev: Optional[float] = Field(
default=None,
description="The standard deviation in percent (normalized) price difference in the"
+ " analyst's ratings since the date of recommendation",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="overall_stdev",
)
gain_count_1m: Optional[int] = Field(
Expand All @@ -141,14 +141,14 @@ class BenzingaAnalystSearchData(AnalystSearchData):
average_return_1m: Optional[float] = Field(
default=None,
description="The average percent (normalized) price difference per rating over the last month",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="1m_average_return",
)
std_dev_1m: Optional[float] = Field(
default=None,
description="The standard deviation in percent (normalized) price difference in the"
+ " analyst's ratings over the last month",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="1m_stdev",
)
smart_score_1m: Optional[float] = Field(
Expand All @@ -159,7 +159,7 @@ class BenzingaAnalystSearchData(AnalystSearchData):
success_rate_1m: Optional[float] = Field(
default=None,
description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="1m_success_rate",
)
gain_count_3m: Optional[int] = Field(
Expand All @@ -176,14 +176,14 @@ class BenzingaAnalystSearchData(AnalystSearchData):
default=None,
description="The average percent (normalized) price difference per rating over"
+ " the last 3 months",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="3m_average_return",
)
std_dev_3m: Optional[float] = Field(
default=None,
description="The standard deviation in percent (normalized) price difference in the"
+ " analyst's ratings over the last 3 months",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="3m_stdev",
)
smart_score_3m: Optional[float] = Field(
Expand All @@ -194,7 +194,7 @@ class BenzingaAnalystSearchData(AnalystSearchData):
success_rate_3m: Optional[float] = Field(
default=None,
description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="3m_success_rate",
)
gain_count_6m: Optional[int] = Field(
Expand All @@ -211,14 +211,14 @@ class BenzingaAnalystSearchData(AnalystSearchData):
default=None,
description="The average percent (normalized) price difference per rating over"
+ " the last 6 months",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="6m_average_return",
)
std_dev_6m: Optional[float] = Field(
default=None,
description="The standard deviation in percent (normalized) price difference in the"
+ " analyst's ratings over the last 6 months",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="6m_stdev",
)
gain_count_9m: Optional[int] = Field(
Expand All @@ -235,14 +235,14 @@ class BenzingaAnalystSearchData(AnalystSearchData):
default=None,
description="The average percent (normalized) price difference per rating over"
+ " the last 9 months",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="9m_average_return",
)
std_dev_9m: Optional[float] = Field(
default=None,
description="The standard deviation in percent (normalized) price difference in the"
+ " analyst's ratings over the last 9 months",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="9m_stdev",
)
smart_score_9m: Optional[float] = Field(
Expand All @@ -253,7 +253,7 @@ class BenzingaAnalystSearchData(AnalystSearchData):
success_rate_9m: Optional[float] = Field(
default=None,
description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="9m_success_rate",
)
gain_count_1y: Optional[int] = Field(
Expand All @@ -270,14 +270,14 @@ class BenzingaAnalystSearchData(AnalystSearchData):
default=None,
description="The average percent (normalized) price difference per rating over"
+ " the last 1 year",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="1y_average_return",
)
std_dev_1y: Optional[float] = Field(
default=None,
description="The standard deviation in percent (normalized) price difference in the"
+ " analyst's ratings over the last 1 year",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="1y_stdev",
)
smart_score_1y: Optional[float] = Field(
Expand All @@ -288,7 +288,7 @@ class BenzingaAnalystSearchData(AnalystSearchData):
success_rate_1y: Optional[float] = Field(
default=None,
description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="1y_success_rate",
)
gain_count_2y: Optional[int] = Field(
Expand All @@ -305,14 +305,14 @@ class BenzingaAnalystSearchData(AnalystSearchData):
default=None,
description="The average percent (normalized) price difference per rating over"
+ " the last 2 years",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="2y_average_return",
)
std_dev_2y: Optional[float] = Field(
default=None,
description="The standard deviation in percent (normalized) price difference in the"
+ " analyst's ratings over the last 2 years",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="2y_stdev",
)
smart_score_2y: Optional[float] = Field(
Expand All @@ -323,7 +323,7 @@ class BenzingaAnalystSearchData(AnalystSearchData):
success_rate_2y: Optional[float] = Field(
default=None,
description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="2y_success_rate",
)
gain_count_3y: Optional[int] = Field(
Expand All @@ -340,14 +340,14 @@ class BenzingaAnalystSearchData(AnalystSearchData):
default=None,
description="The average percent (normalized) price difference per rating over"
+ " the last 3 years",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="3y_average_return",
)
std_dev_3y: Optional[float] = Field(
default=None,
description="The standard deviation in percent (normalized) price difference in the"
+ " analyst's ratings over the last 3 years",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="3y_stdev",
)
smart_score_3y: Optional[float] = Field(
Expand All @@ -358,7 +358,7 @@ class BenzingaAnalystSearchData(AnalystSearchData):
success_rate_3y: Optional[float] = Field(
default=None,
description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
alias="3y_success_rate",
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,42 +79,42 @@ class FinvizCompareGroupsData(CompareGroupsData):
performance_1D: Optional[float] = Field(
default=None,
description="The performance in the last day, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
performance_1W: Optional[float] = Field(
default=None,
description="The performance in the last week, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
performance_1M: Optional[float] = Field(
default=None,
description="The performance in the last month, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
performance_3M: Optional[float] = Field(
default=None,
description="The performance in the last quarter, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
performance_6M: Optional[float] = Field(
default=None,
description="The performance in the last half year, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
performance_1Y: Optional[float] = Field(
default=None,
description="The performance in the last year, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
performance_YTD: Optional[float] = Field(
default=None,
description="The performance in the year to date, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
dividend_yield: Optional[float] = Field(
default=None,
description="The dividend yield of the group, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
pe: Optional[float] = Field(
default=None,
Expand All @@ -132,23 +132,23 @@ class FinvizCompareGroupsData(CompareGroupsData):
eps_growth_past_5_years: Optional[float] = Field(
default=None,
description="The EPS growth of the group for the past 5 years, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
eps_growth_next_5_years: Optional[float] = Field(
default=None,
description="The estimated EPS growth of the groupo for the next 5 years,"
+ " as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
sales_growth_past_5_years: Optional[float] = Field(
default=None,
description="The sales growth of the group for the past 5 years, as a normalized percent.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
float_short: Optional[float] = Field(
default=None,
description="The percent of the float shorted for the group, as a normalized value.",
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
analyst_recommendation: Optional[float] = Field(
default=None,
Expand Down
Loading
Loading