Files
OpenBB/cli/tests/test_codegen_pydantic_gen.py
Danglewood bbf1ab2020 V5 (#7489)
* [Feature] OpenBB V5: Initial `openbb-core` Refactor (#7482)

* initial refactor

* ruff does not dictate style

* unresolved imports in test action

* fix general linting

* resolve pandas imports for actions run

* httpx in test workflow

* pytest-asyncio in test workflow

* pandas.Index(...)

* max version for windows CI is 3.14

* remove temp refactor files that shouldn't have been committed:

* use ruff format instead of black

* formatting and typing

* tab space helper

* test fixtures..

* ty check

* also run integration test in CI

* remove that annoying labeler action

* [V5] `openbb-core`: 100% Test Coverage (#7484)

* increase test coverage to exercise 100% of the testable code path in openbb-core

* model_fields syntax cleanup

* set the environment variable for CI runs

* run codeql on v5 branch

* more CI env setup

* cleanup redundant files

* ruff

* dedupe workflow trigger

* some windows coverage missing

* ubuntu integration test job

* more windows coverage

* test_reference_generator

* test_docstring_generator

* remove line no references from test function docstrings

* clean useless comments from test files

* fix polars type check

* fix test_obbject

* fix test_obbject

* package builder fixes

* charting pyproject version

* fix docstring generator for nested models

* missing coverage

* [V5] `openbb-core`: Add Backwards-Compatible Layered Config System (openbb.toml) (#7492)

* add backwards-compatible layered config system

* fix path reference in windows test

* need python version-aware handling in docstring generator

* update for deprecated pydantic syntax

* ruff UP007

* test_system_settings

* remove v4 platform workflow

* [V5] Refactor `openbb-oecd` for full SDMX 2 API Exposure and V5 Packaging (#7413)

* stash some changes

* add more robust testing

* mypy

* point PR at V5

* introduce spec file

* codespell

* test fix

* fix workflow environment setup

* fix workflow environment setup

* fix workflow environment setup

* add pyyaml to dependencies

* split lint jobs

* fix workflow environment setup

* fix workflow environment setup

* workflow env setup

* workflow env setup

* clean up code comments

* add auth hook entrypoints

* codespell

* add codegen feature

* codespell

* move _unpack into dispatchers for consistency with codegen packages

* surface nested models in the response

* fix missing coverage in CI

* socrata updates

* test fix

* detect plotly output

* add --include and --exclude flags from generate-extension command

* refactor openbb-platform-api for V5 operations and spec file handling

* delete poetry.lock

* add test workflow

* add temp branch id for test workflow

* add httpx to dev dependencies

* add a conftest.py

* tweak conftest

* tweak conftest

* python 3.10 issues

* more python 3.10

* more python 3.10

* more python 3.10

* more python 3.10

* fix url template resolution

* multi-spec support

* fix a windows path issue

* merge branch develop

* table builder, integration tests, and more

* linting

* merge branch develop

* bit of cleanup

* some more updates, cleanup, and apps.json

* codespell

* black

* integration test params and linting

* mypy

* pylint

* black

* more pylint

* recapture teest cassettes

* black again

* more linting

* table presentation choices

* black

* fix merge conflict

* split up metadata module and reformat cache to use msgpack

* mypy

* regenerate lock file

* use json and include dependencies to make openbb-oecd a standalone install

* pylint

* more linting

* serve metadata as dependency instead of assign and initialize

* fix integration_tests_testers to not count dependency injections as paramters

* add assets to git ignore

* ruff

* v5 refactor and publish workflow

* test coverage and ty fixes

* codespell

* update lock file

* workflow setup

* ty check

* workflow setup

* Scope PR to OECD changes only

Restore non-OECD files in the diff against v5 to their v5 state. The
branch was originally created off feature/cli-2 and inherited 186 files
of unrelated changes (cli, agent_server, mcp_server, platform_api,
core/, .github/workflows/* not oecd). Those have nothing to do with the
openbb-oecd v5 refactor and were polluting the PR diff.

* scope cleanup: include leaked v5-resident files (general-linting workflow, platform_api test fixtures)

---------

Co-authored-by: deeleeramone <>
Co-authored-by: Copilot <copilot@github.com>

* fix docstring generator and body param unwrapping

* project ty.toml file

* unpack POST parameters from params: Model

* remove comment chatter

* [V5] `openbb-oecd`: Rename `oecd_utils` as `oecd` (#7509)

* rename oecd_utils to oecd and populate all models there when openbb-economy is not installed

* linting

* bump dependencies

* fix test drift

* linter

* FieldInfo import

* [V5] `openbb-imf`: Refactor for V5 (#7508)

* refactor imf extension for V5

* codespell

* fix some python 3.10 items

* return self on copy of metadata object

* [V5] `openbb-news`: Refactor News for V5 and Add Configurable RSS Endpoint (#7507)

* refactor news for v5 and add rss endpoint

* remove poetry.lock

---------

Co-authored-by: deeleeramone <>

* [V5] `openbb-quantitative`: Refactor for V5 (#7506)

* refactor quantitative for v5

* add factors endpoint and add a few charts

---------

Co-authored-by: deeleeramone <>

* [V5] `openbb-technical`:  Refactor for V5 & Add More Quick Win Endpoints (#7502)

* refactor openbb-technical for v5

* forward refs

* linting

* no python 3.15 in test matrix

* reame

* ty

* move all params to body

---------

Co-authored-by: deeleeramone <>

* remove stockgrid provider (#7486)

* [V5] remove wsj provider and related code (#7485)

* remove wsj provider and related code

* purge from metadata

* actions

* actions

* openbb-core publish workflow

* delete biztoc (#7523)

* [V5] Remove `openbb-alpha-vantage` (#7522)

* delete alpha vantage

* more files

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>

* [V5] Remove `openbb-benzinga` (#7521)

* delete benzinga

* more references

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>

* [V5] `openbb-bls`: Refactor for V5 + Add Many Endpoints (#7518)

* refactor bls for v5, add 100 widgets

* some CI fixes

* no python 3.15

* fix missing dev group in pyproject.toml

* more pyproject fallout

* action

* refactor econometrics for v5 (#7505)

Co-authored-by: deeleeramone <>

* [V5] `openbb-famafrench`: Refactor for V5 (#7503)

* refactor famafrench for v5

* codespell

* finishing touches

---------

Co-authored-by: deeleeramone <>

* [V5] CLI 2.0 - Pluggable Backends, Non-TTY Default, HTTP Dispatcher, Spec Files + Codegen (#7433)

* stash some changes

* add more robust testing

* mypy

* point PR at V5

* introduce spec file

* codespell

* test fix

* fix workflow environment setup

* fix workflow environment setup

* fix workflow environment setup

* add pyyaml to dependencies

* split lint jobs

* fix workflow environment setup

* fix workflow environment setup

* workflow env setup

* workflow env setup

* clean up code comments

* add auth hook entrypoints

* codespell

* add codegen feature

* codespell

* move _unpack into dispatchers for consistency with codegen packages

* surface nested models in the response

* fix missing coverage in CI

* socrata updates

* test fix

* detect plotly output

* add --include and --exclude flags from generate-extension command

* cap test matrix at python 3.14

* no useless comments

* platform controller command description split

* merge URL overloads from path params

* exclude none and unset from model dump

---------

Co-authored-by: deeleeramone <>
Co-authored-by: Copilot <copilot@github.com>

* general-linting

* downgrade aiohttp in devtools for vcrpy

* some ty items and add requests-types stubs for ty in devtools

* markdown linting

* remove integration tests from extensions that were moved into the famafrench provider

* [V5] `openbb-congress-gov`: Refactor for V5 + Convert To Using Bulk Files Instead of `api.congress.gov`. (#7528)

* refactor congress-gov for v5 and use bulk files instead of API with credentials

* integration tests

* apps tab name

* convert caching to sql

* codespell

* [V5] [BugFix] Fix for Breaking Changes in FastAPI 0.137+ (#7537)

* fix route introspection for fastapi 0.137

* recapture oeccd gdp forecast test cassette

---------

Co-authored-by: deeleeramone <>

* [V5] `openbb-platform-api`: Refactor for V5 Spec, Config, Packaging, Test Coverage (#7494)

* stash some changes

* add more robust testing

* mypy

* point PR at V5

* introduce spec file

* codespell

* test fix

* fix workflow environment setup

* fix workflow environment setup

* fix workflow environment setup

* add pyyaml to dependencies

* split lint jobs

* fix workflow environment setup

* fix workflow environment setup

* workflow env setup

* workflow env setup

* clean up code comments

* add auth hook entrypoints

* codespell

* add codegen feature

* codespell

* move _unpack into dispatchers for consistency with codegen packages

* surface nested models in the response

* fix missing coverage in CI

* socrata updates

* test fix

* detect plotly output

* add --include and --exclude flags from generate-extension command

* refactor openbb-platform-api for V5 operations and spec file handling

* delete poetry.lock

* add test workflow

* add temp branch id for test workflow

* add httpx to dev dependencies

* add a conftest.py

* tweak conftest

* tweak conftest

* python 3.10 issues

* more python 3.10

* more python 3.10

* more python 3.10

* more python 3.10

* fix url template resolution

* multi-spec support

* fix a windows path issue

* cap test matrix at python 3.14

* no 3.15 runners for platform-api

* no useless comments

* platform controller command description split

* merge URL overloads from path params

* exclude none and unset from model dump

* markdown lint

* ignore get/post endpoints that are return SSE

* fix remaining fastapi 0.137 fallout

---------

Co-authored-by: deeleeramone <>
Co-authored-by: Copilot <copilot@github.com>

* add full support for AsyncIterator response type for streaming output (#7530)

* [V5] Refactor Shared Pass Through Router Extensions For Hatchling (#7524)

* refactor shared pass-through routers for hatchling and ruff + ty

* add publish workflows

* [V5] `openbb-charting`: Refactor for V5 and Decouple  (#7545)

* refactor charting for v5 patterns and decouple entirely

* coveragerc

* lint and tests

* fix tests

* configure dev group with openbb-technical

* ty

* fix cli test

* remove 3.15 from test matrix - dependencies are unstable

---------

Co-authored-by: deeleeramone <>

* fix merge widgets

* workflow cleanup"

* fixes for ty

* fogot that file

* general lint setup

* consolidate lint job

* remove seeking alpha provider (#7570)

* remove tradier provider (#7573)

* remove tiingo provider (#7574)

* remove intrinio provider (#7575)

Remove the openbb-intrinio provider extension from the repository.
Reason: proprietary vendor with no internal access to any endpoint;
cannot build, develop or maintain.

* remove yfinance provider from repo (#7576)

* fix(cli): resolve modular OpenAPI references (#7586)

Fixes #7585

* [V5] `openbb-cli`: Modular OpenAPI Refs (#7589)

* follow up to #7585

* add another codegen test

* unused ty ignore

* Update generated tests to get python parameter names instead of raw API-provider parameter names. (#7597)

* Update the record-vs-envelope heuristic in the payload processing code to not treat a record that happens to have a list datatype as an entire envelope. (#7598)

* Update class generation code to handle empty data that php-style serialization emits as []. (#7599)

* fix ty check failures exposed by newer version

* add drugs.com and brutalist as news rss feeds (#7602)

Co-authored-by: deeleeramone <>

* codespell

* missing test coverage that appeared in famafrench..

* plotly 7 handling for mapbox namespace change

* remove finviz (#7577)

* remove trading economics provider (#7578)

* remove openbb-multpl from repository (#7610)

* add httpx2 to devtools for starlette test client

* restore test coverage to 100% in openbb_core

* remove fmp provider extension from repository (#7665)

* unpin ruff

* fix charting conftest and missing coverage in 3.10

* add charting coverage

* fix new ty issues

* fix tag grouping in swagger docs

* [V5] `openbb-ecb`: Refactor for V5 and Expand Coverage (#7560)

* refactor openbb-ecb for v5 and expand coverage

* some updates

* tests

* workflow

* remove 3.15 from test matrix

* some more table schema updates

* remove some html chrome on embedded articles

---------

Co-authored-by: deeleeramone <>

* [V5] `openbb-federal-reserve`: Refactor for V5 + FFIEC & Regional Fed Routers (#7561)

* refactor for v5

* add workflows

* fix bhcpr schema

* fix pyproject.toml

* fix test

* codespell

* ty

* fix pyproject

* fix ci environment

* fix ci environment

* convert documents endpoints to use fedinprint service

* codeql fix

* fix ny publications and add ny nowcast

* [V5] `openbb-eia`: Refactor for V5 + Add Full API Implementation (#7584)

* eia refactor for v5

* add test and publish workflows

* data browser state

* fix workflows

* more workflow test items

* temp files in tests

* more fixes

* more browsers

* fix codeql issues

* fix mer state and ensure multi-user capability

* uv lock

* table bridge

* fix electricity browser state

* convert HTML widgets to iFrame

* fix recursion error in workspace mcp

* [V5] `openbb-government-us`: Refactor for V5 + Move `uscongress` (#7604)

* v5 government_us provider

* workflow files

* ty and add xlrd to pyproject

* shrink test cassettes

* dev dependencies

* wheel packaging and more tests

* python 3.10 thing..?

* fix test

* default state for multiselect dropdowns

* replace congress html widgets with iframes

* fallback to congress api for congress before 108

* ensure member passage voting count populates

* [V5] Feature: Add JODI World Oil & Gas Database (#7593)

* add the JODI oil and gas database as a provider/router extension

* lint fixes

* add grouping to apps.json

---------

Co-authored-by: deeleeramone <>

* [V5] `openbb-cftc`: Refactor for V5 + Add OIS, Forward Curve, and FX Trade Analysis (#7615)

* refactor openbb-cftc for v5

* add SHIBOR to fixings

---------

Co-authored-by: deeleeramone <>

* fix for plotly 7 breaking change to schemas

* [V5] `openbb-tmx`: Refactor extension for V5 (#7668)

* refactor tmx provider for v5

* fix tests..

* fix tests stack trace exposure

* fix workflow setup

* [V5] `openbb-nasdaq`: Refactor provider for V5. (#7670)

* refactor nasdaq provider for v5

* add workflows

* ty fix

* [V5] `openbb-fred`: Refactor as V5 extension. (#7669)

* refactor fred extension for v5

* fix markdown MD037 lint error in README

* codespell

* [V5] `openbb-cboe`: Refactor for V5 + Add Payoff Diagrams (#7617)

* refactor cboe for v5

* use zoneinfo instead

* fix test

* some fixes related to the cache access

* fix a couple of tests

* fix the test coverage

* [V5] `openbb-deribit`: Refactor provider for V5 (#7674)

* refactor openbb-deribit for v5

* restructure the optimizer around the published combos data and add integration test suites

* fix markdown lint errors

* remove openbb-econdb provider (#7675)

* codespell

* [V5] `openbb-sec`: Refactor for V5 (#7525)

* refactor openbb-sec for v5

* linting

* ty

* normalize compare_company_facts

* add workflows

* python 3.10 fix

* add more thorough url validation and tests

* ty check

* ty for python 3.10

* reconfigure with apps

* temp pyproject overrride

* pyproject

* pyproject

* pyproject

* codespell

* pyproject

* fix uk schema file links in schema_files

* test coverage

* test_cli

* port #7547 into this pr

* no hard coded prefix

* improve filing rendering capabilities

* fix xml text detection

* make codeql happy

* missed a file in the commit

* test coverage

* codespell

* fix flakey test

* some updates

* management_ownership --> management_profiles

* proxy statement markdown

* ruff

* fix test coverage

* more tests

* test coverage

* fix lint errors

* Add SEC adviser search, profile, and universe routes (#7559)

* Add SEC institutional data fetchers

* Add SEC filing index and Form D routes

* Add SEC investment adviser people data

* Expose SEC adviser and institutional routes

* fix(sec): address adviser review feedback

* refactor(sec): narrow adviser support to IAPD search

* feat(sec): add adviser firm and individual searches

* feat(sec): add adviser profile drill-down

* fix: repair pre-commit configuration

* feat(sec): add adviser universe route

* feat(sec): expose complete Form ADV data

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>

* fix test coverage

---------

Co-authored-by: deeleeramone <>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>

* [V5] `openbb-finra`:  Refactor for V5 (#7676)

* refactor finra provider for v5

* add workflows

* fix tests

* fix lint errors

* [V5] Update Repository License to Apache 2.0 (#7677)

* change license to Apache 2.0 for V5

* codespell

* bump devtools and repoint pyproject.toml

* Enterprise Flask Migration Toolkit (#7264)

* feat: Add Flask-to-OpenBB enterprise migration toolkit

- Implement Router.from_flask() for zero-touch legacy API conversion
- Enable 4-hour migration vs 6-month traditional rewrite (80% cost reduction)
- Generate FastAPI endpoints from Flask routes with automatic type validation
- Support enterprise consulting services and custom integration workflows

Demonstrates OpenBB's competitive advantage for institutional client migrations.
Complements existing Workspace applications like Open Portfolio suite.

* chore: Resolve .gitignore conflict and add common ignores

* refactor: implement Phase 1 Flask integration architecture- Move Flask conversion logic to openbb_core.app.utils.flask- Add Flask detection to extension_loader - Integrate with OpenBB's core extension system- Add Flask dependency validation with sys.modules checkingAddresses @deeleeramone's architectural feedback for native OpenBB integration.

* docs: add Flask direct entry point demos- demo_direct_flask_entry_point.py: shows direct Flask instance reference- example_pyproject_flask_entry.toml: demonstrates pyproject.toml configurationSupports new architecture eliminating wrapper extensions.

* Implement Phase 1 Flask adapter per code review feedback

- Minimal working implementation with Flask detection and router creation
- Removes complex code generation logic for focused Phase 1 delivery
- Establishes foundation for Phase 2 route conversion features

* Fix Flask integration: Replace missing FlaskToOpenBBAdapter with WSGIMiddleware

- Remove FlaskToOpenBBAdapter which was not implemented
- Use FastAPI's WSGIMiddleware to mount Flask apps directly
- Update extension_loader to use returned Router object
- Convert utils.py to utils/__init__.py to support flask submodule
- Addresses PR review comment about unhandled AttributeError

* Address PR review feedback: fix Flask imports and remove unused files

- Revert .gitignore to upstream/develop
- Remove AI-generated demo/example files and flask_adapter extension
- Move Flask/werkzeug imports inside conditional blocks to avoid ImportError
- Use lazy imports via __getattr__ in utils/flask/__init__.py
- Add Flask tests with @pytest.mark.skipif markers

* Force APIRouter.include_router to propagate Mount paths instead of dropping them. (#1)

This change ensures that mounted ASGI applications (such as Flask apps wrapped in WSGIMiddleware) are not dropped when `APIRouter.include_router` is called.

Previously, while the initial load in `ExtensionLoader` worked as expected, the `Mount` objects were ignored by FastAPI's default inclusion logic. This caused the mounted elements to be lost during the final application assembly, resulting in 404 errors for the Flask routes.

This fix overrides the inclusion logic to manually propagate `Mount` objects downstream.

* feat(flask): Add metadata layer for OpenAPI documentation

Enhance Flask-to-OpenBB converter with structured docstring parsing:
- Parse Google-style docstrings (summary, description, params)
- Extract parameter descriptions from Args section
- Pass metadata to Router.command() for rich OpenAPI docs

This addresses PR feedback to provide tangible benefit by generating
comprehensive API documentation for migrated Flask routes.

* feat(flask): Implement manual OpenAPI spec generation and attachment

- Add FlaskParam and FlaskRouteInfo TypedDict for type-safe metadata
- Implement OpenAPISpecGenerator for Flask→OpenAPI conversion
- Extract route metadata via FlaskIntrospector
- Attach generated spec to router.openbb_openapi_spec_ext
- Add unit tests (3/3 passing)

Addresses WSGI/mount boundary issue where Router.command metadata
cannot propagate through WSGIMiddleware. Spec attached to router
instance for downstream OpenAPI assembly.

Resolves maintainer feedback on PR #7264

* feat(flask): Implement FlaskMountRegistry for multiple mount support

- Add FlaskMountRegistry class for centralized OpenAPI spec management
- Replace router.openbb_openapi_spec_ext with registry pattern
- Support multiple Flask apps at different mount prefixes
- Automatic path rewriting in aggregated OpenAPI specs
- Add registry test case (4/4 tests passing)

Addresses @deeleeramone's feedback on PR #7264 regarding router
attribute fragility and multiple mount support. Registry provides
lifecycle-independent state management and enables enterprise
scenarios with multiple Flask apps.

Resolves: OpenBB-finance/OpenBB#7264 (partial)

* feat(core): load Flask apps as openbb_core_extension WSGI sub-apps

A Flask app referenced directly by an openbb_core_extension entry point is
mounted via WSGIMiddleware and its routes are introspected into openapi.json
(operationId/widgetId/mcp_tool, parameters, request bodies, security, widget_config
and HTML widgets) so the widget factory and MCP server can discover them.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* test(core): 100% coverage for flask utils + flask dev dependency

Add branch-coverage tests for the Flask integration package (introspection,
AST analysis, docstrings, OpenAPI generation, registry, loader, detection) and
declare flask as a dev dependency so the suite runs in CI.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(flask): treat f-string returns as HTML responses

* fix(flask): mount via a2wsgi instead of deprecated starlette WSGIMiddleware

- add openbb-core[flask] extra (flask, a2wsgi); a2wsgi resolved through require_optional
- run the WSGI serve test through mount_flask_extensions; drop httpx importorskip
- core CI installs [pandas,flask] and httpx2

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* test(flask): cover failed entry point loads; narrow optional types for ty

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: deeleeramone <>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

* perf(core): vectorize the date conversion in `basemodel_to_df` (#7622)

* perf(core): vectorize the date conversion in basemodel_to_df

basemodel_to_df ran three per-element Python passes over the date column of
every payload it converted. Series.apply(to_datetime) calls pandas.to_datetime
once per row, and because each call receives a lone scalar with no format hint,
pandas also re-runs its datetime format guesser on every row.

Parse the column in one call instead, and use vectorized comparisons for the
all-midnight test and the reduction to datetime.date.

The element-wise parse is kept as a fallback for one case that the vectorized
path cannot represent: a column mixing UTC offsets, such as a series crossing a
daylight-savings boundary. Parsing per element lets each value keep its own
offset and yields an object column of tz-aware Timestamps, whereas a single
to_datetime call over that column raises "Mixed timezones detected". That
behaviour is covered by test_to_df_daylight_savings and is preserved exactly.

Measured on a payload built through EquityHistoricalData, median of 9 under an
exclusive CPU lock:

  250 daily bars     8.92 ms -> 1.46 ms
  1,000 daily bars  32.93 ms -> 3.13 ms
  5,000 daily bars 162.25 ms -> 12.23 ms

* fix a broken test - unrelated to this PR...

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: deeleeramone <>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

* fix lint errors

* fix oecd lint error

* [V5] `openbb-mcp-server`: Refactor for v5 - Spec, Config, Packaging, Test Coverage (#7495)

* stash some changes

* add more robust testing

* mypy

* point PR at V5

* introduce spec file

* codespell

* test fix

* fix workflow environment setup

* fix workflow environment setup

* fix workflow environment setup

* add pyyaml to dependencies

* split lint jobs

* fix workflow environment setup

* fix workflow environment setup

* workflow env setup

* workflow env setup

* clean up code comments

* add auth hook entrypoints

* codespell

* add codegen feature

* codespell

* move _unpack into dispatchers for consistency with codegen packages

* surface nested models in the response

* fix missing coverage in CI

* socrata updates

* test fix

* detect plotly output

* add --include and --exclude flags from generate-extension command

* refactor mcp server for v5

* test action

* fix tests

* tests

* test fixture name

* revert: drop unrelated provider/README changes from mcp-server refactor

Strip the changes to ``README.md`` and ``openbb_platform/providers/{imf,
tradingeconomics,yfinance}`` that snuck into 4ac3602 (refactor mcp server
for v5). Those files are out of scope for the mcp-server work and were
modified inadvertently — restore them to their pre-4ac3602 state.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* tests and workflows

* fix workflow

* tests and workflows

* tests and workflows

* tests and workflows

* tests and workflows

* beartype shim for 3.15

* muck around with beartype for 3.15

* muck around with beartype for 3.15

* no 3.15 runners for mcp-server

* update skill files

* cap test matrix at python 3.14

* merge branch v5

* no useless comments

* platform controller command description split

* merge URL overloads from path params

* exclude none and unset from model dump

* refactor for fastmcp4

* wrap markdown lines that are too long

---------

Co-authored-by: deeleeramone <>
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* update pre-commit, noxfile, and uv locks

* fixes for docstring generation

* test coverage

* fix cli renderer helper with figure object JSON

* fix the figure font when rendered

* refactor cookiecutter

* bump cookiecutter packagge version

* fix sec test by adding fixture

* fix desktop environments test

* fix(cli): inherit path-item-level OpenAPI parameters (#7606)

* fix(cli): inherit path-item-level OpenAPI parameters

OpenAPI 3.x lets a Path Item Object declare `parameters` shared by every
operation under that path, with operation-level entries overriding them by
(name, in). The codegen read only `op.get("parameters")`, so inherited
parameters were dropped silently — the generated command kept the URL
template but had nothing registered to fill it.

Real-world impact: the Xero Accounting API declares its required
`xero-tenant-id` header once per path item across all 138 paths. Before this
change `build_command_spec` produced 78 commands and none carried the
header, so every generated command 403s. Nothing warned.

Adds `operation_parameters()`, which merges the two levels and dereferences
both, and routes the pre-computed spec path (`build_command_spec`) and the
interactive path (`build_command_index` -> `build_parser_from_operation`)
through it. Unresolvable refs, non-dict entries, and nameless parameters are
skipped as before. Specs without path-item parameters are unaffected.

* fix(cli): narrow path-item inheritance to path and query parameters

Per review: headers do not translate into a Python interface function, and
outbound headers are transport configuration
(SystemSettings.PythonSettings.http.headers, the CLI's -H) or a security-scheme
concern — not a per-command argument.

Path-item `in: header` and `in: cookie` entries are now dropped rather than
inherited. Operation-level parameters are untouched, so an operation that
declares its own header keeps today's behavior.

Scope is now only what cannot be supplied any other way: `in: path` and
`in: query` parameters declared on the Path Item Object.

* fix(cli): merge allOf compositions in response schemas

Response-schema $refs were already expanded by deref_schema, but a schema
whose top level is an allOf composition was left unflattened. The properties
live inside the members, so a consumer reading them off the composition finds
none. fetcher_gen._data_schema looks for `properties.results`, gets nothing,
and falls through to _unwrap_schema_envelopes, which handles oneOf and anyOf
but not allOf. The generated Data model ends up with no fields.

Codat's listBills response is `allOf: [{properties: {results}}, {properties:
{_links, pageNumber, pageSize, totalResults}}]`, which produced an empty model.

merge_allof collapses a composition of object subschemas into one object
schema: properties unioned with the first declaration winning on conflict,
required unioned, and sibling keywords on the allOf node outranking members.
A composition that is not a plain intersection of object subschemas (a member
carrying its own oneOf/anyOf, or a non-object type) is returned unchanged
rather than flattened into something the spec does not describe. Nested
compositions are merged too, so a $ref inside a merged member still resolves.

Applied to extract_response_schema and extract_response_schemas.

Measured across five specs that use the pattern, counting operations whose
response schema exposes readable properties: 244 of 588 before, 394 after
(Codat Accounting 36 to 88, Codat Banking 0 to 8, Codat Commerce 1 to 11,
Rebilly 62 to 104, Box 145 to 183).

* fix(cli): merge allOf compositions in request body schemas

Same gap as the response side. request_body_parameters needs `type: object`
or `properties` to flatten a body into parameters, and an allOf composition
carries neither, so a POST or PUT generated from one gets no body parameters
at all.

extract_request_body_schema now runs merge_allof after deref_schema, matching
extract_response_schema.

Across the same five specs, counting request bodies that produce parameters:
138 of 206 before, 177 after (Codat Accounting 1 to 26 of its 30 bodies,
Rebilly 50 to 63, Box 87 to 88).

* fix(cli): stop annotation keywords blocking an allOf merge

_mergeable_allof_members required every member's keys to come from a small
whitelist, so any unrecognized keyword disqualified the whole composition.
Codat's PagingInfo carries `definitions` next to its properties, which meant
the live Codat-Accounting.yaml never merged and its response models stayed
empty. The APIs.guru copy of the same API omits that key, which is why the
earlier measurements looked clean.

The check is now a blocklist. A member blocks the merge when it carries its
own combinator (oneOf/anyOf/allOf/not), an unresolved $ref left by a cycle,
a scalar or array constraint (enum/const/items), or a type other than object.
Annotation keywords that do not affect the intersection (title, description,
examples, definitions, additionalProperties, vendor x- keys) no longer block
it, and are dropped from the merged result along with the members.

On the live Codat spec, operations whose response schema exposes readable
properties go from 36 of 127 to 114. Across the five specs measured earlier:
244 of 588 before, 488 after (was 394 under the whitelist).

Corpus check over 2,816 response and request-body extractions in 6 specs:
567 changed, every one attributable to an allOf in the pre-merge output,
0 unexplained. Twilio declares no allOf compositions and is unchanged.

* fix(cli): emit a name once when it is both a parameter and a body property

_signature_params appended request-body properties and then operation
parameters without deduplicating, so a name declared in both places produced
two function parameters with the same name and the generated module raised
SyntaxError.

Codat's push endpoints hit this: /push/bankAccounts/{accountId}/bankTransactions
declares accountId as a path parameter and repeats it in the request body, so
connections.push.bankAccounts.bankTransactions generated `accountId: str` and
`accountId: str = None` in one signature.

The operation parameter wins, since it carries the path placeholder and its own
required flag. The request payload is unchanged: _render_body_block derives body
fields from request_body_schema rather than from this list, so accountId is
still sent in the body.

This predates the path-item and allOf work in this PR. On origin/v5 the same
spec produces the same duplicate; on this branch the Codat spec generates 91
commands with 0 duplicated signatures, down from 1.

* fix(cli): use the safe identifier for keyword-named body properties

_render_body_block already writes `{'from': from_}`, keying the payload by the
wire name and reading a safe identifier, but _signature_params declared the raw
name. A body property named after a Python keyword therefore emitted
`from: str = None` and the generated module raised SyntaxError.

This did not fire before the allOf work in this PR, because a composed request
body produced no body parameters at all. Codat's Transfer body is such a
composition and has a `from` property, so connections.push.transfers started
generating invalid syntax once the body flattened.

_signature_params now emits safe_field_name(name)[0], the same helper
fetcher_gen and pydantic_gen already use. The body/query split in
_render_body_block compares against the safe names too: it previously matched
signature names against wire names, so `from_` was not recognized as a body
field and leaked into the query string as a `from_` parameter.

End to end on Codat-Accounting.yaml, generating the full extension and byte
compiling every emitted module: 136 files, 0 failures. origin/v5 emits 1 file
that does not compile (duplicate argument 'accountId').

Known gap left alone: an operation parameter named after a keyword would still
break, since the query and path lines use the raw name as a local variable.
None of the five specs checked declares one.

* fix(cli): do not treat instance data as schema, and sanitize POST identifiers

Two defects found by generating extensions from real specs and byte compiling
every emitted module.

merge_allof and deref_schema walked every value in a schema dict, including
keywords that hold instance data rather than subschemas. A `default` of
`{"allOf": [{"a": 1}, {"b": 2}]}` was rewritten to `{"type": "object"}`, and a
`$ref` key inside an example was resolved as if it were a reference. Both now
copy `default`, `example`, `examples`, `enum`, `const` and vendor `x-` values
through untouched.

_signature_params emitted operation parameter names verbatim, so a wire name
that is not a Python identifier produced invalid syntax. Rebilly declares an
`Organization-Id` header and a `REB-APIKEY` security header, which emitted
`REB-APIKEY: str = None`. It now uses safe_field_name, matching fetcher_gen,
and _render_body_block keys the query dict by the wire name while reading the
safe identifier so the request is unchanged.

This surfaced through the allOf work rather than being caused by it: a composed
request body used to yield no properties, so `has_body` was false in
package_gen and the command was generated as a GET fetcher, where identifiers
were already sanitized. With bodies flattening, 14 of Codat's 24 POST endpoints
correctly move to the POST path, which had never been exercised by these specs.

Generating the full extension and compiling every module:

  Codat-Accounting.yaml   v5: 1 failure    branch: 0   (136 files)
  Rebilly 2.1             v5: 14 failures  branch: 1   (97 files)

The one remaining Rebilly failure is `async def 3dsecure(` in the router, which
fails identically on v5. Sanitizing that is a naming decision about the command
surface, so it is left alone here.

Known gap: a non-credential header parameter is still placed in the query
string on the POST path. Pre-existing, and unchanged by this PR.

* fix(cli): resolve signature collisions on the emitted identifier

The previous dedupe compared wire names, but the failure it prevents depends on
the sanitized identifier. Two wire names can collapse onto one (`from` and
`from_`, `Organization-Id` and `Organization_Id`), and operation_parameters
keeps a name declared twice under different `in` locations by design, so both
cases could still emit a duplicate argument.

_signature_params now tracks the identifiers it has emitted and skips anything
that would repeat one. Emission order is unchanged, so existing signatures are
byte-identical; only genuinely colliding names are dropped, and operation
parameters still win over body properties.

Neither collision occurs in Codat-Accounting.yaml or Rebilly 2.1. This closes
the class rather than the instance, since the instances are what this PR has
been finding.

Generation unchanged: Codat 136 files 0 failures, Rebilly 97 files 1 failure
(`async def 3dsecure(`, identical on v5).

* test(cli): cover the instance-data guard, and drop a redundant branch

Mutation checking the new tests (revert each fix, confirm its test fails)
found two problems with the previous commits.

The guard that stops merge_allof and deref_schema from walking into `default`,
`example`, `enum`, `const` and vendor values shipped with no test at all. It is
now covered from both directions: a default holding an `allOf` key keeps its
value, and a `$ref` inside a default stays a literal while a real reference
beside it still resolves.

The body-property loop also carried a redundant check. It tested the raw wire
name against the operation parameter names before testing the sanitized one,
but `operation_param_names` holds both forms and `safe_field_name` is idempotent
on identifiers, so the first test could never fire alone. Reverting it left
every test passing, which is what surfaced it. Removed, and the sanitized name
is now computed once.

All nine mutations are caught by the suite: both data guards, the allOf
blocklist in each direction, the response merge wiring, body/parameter
precedence, the keyword identifier, the body/query split and the
emitted-identifier dedupe.

cli/tests at 1,954 passed against the same 80 environment failures as the base.
Generation unchanged: Codat 136 files 0 failures, Rebilly 97 files 1 failure.

* fix(cli): route required path-item headers/cookies through credential handling

* fix(cli): narrow Popen.stdin/stdout for ty in run_in_obb fixture

---------

Co-authored-by: deeleeramone <>

* fix warnings raised by federal_reserve on some xlsx workbook parsing

* fix publish workflows

* test publish pipeline with openbb-core-v2.0.0rc0 (#7681)

* fix publish workflows with missing tag job, some tests and bump fastapi

* fix python 3.10 test failure in core

* actually fix python 3.10 test failure in core

* deincrement openbb-core version to allow release pattern

* bump core version (#7682)

* remove uv.sources from pyproject.toml files and point to openbb-core-2.0.0 on PyPI

* remove oecd cache asset that wasn't supposed to be commuitted

* remove poetry.lock, update pyproject.tml and uv.lock for openbb-platform-api-v2.0.0 (#7684)

Co-authored-by: deeleeramone <>

* add the missing publish-openbb-platform-api.yml workflow file

* remove poetry.lock, update pyproject.tml and uv.lock for openbb-platform-api-v2.0.0 (#7685)

Co-authored-by: deeleeramone <>

* fix the tag generation after publish

* [Release] `openbb-charting-v4.0.0` (#7686)

* up openbb-charting to 4.0.0 and fill missing test coverage in chart_style

* test coverage and format markdown files

---------

Co-authored-by: deeleeramone <>

* remove scikit-learn from dependencies, update tests, and format markdown files (#7687)

Co-authored-by: deeleeramone <>

* [Release] `openbb-cli-v2.0.0` (#7692)

* fix missing test coverage in openbb_cli

* fix conftest

---------

Co-authored-by: deeleeramone <>

* add missing publish-openbb-cli.yml workflow

* [Release] `openbb-cli-v2.0.0` (#7693)

* fix missing test coverage in openbb_cli

* fix conftest

---------

Co-authored-by: deeleeramone <>

* test fixes for cli...

* [Release] `openbb-cli-v.2.0.0` (#7694)

* fix missing test coverage in openbb_cli

* fix conftest

---------

Co-authored-by: deeleeramone <>

* fix hanging mcp server test

* [Release] `openbb-mcp-server-v2.0.0` (#7695)

Co-authored-by: deeleeramone <>

* update uv.lock (#7696)

Co-authored-by: deeleeramone <>

* release openbb-commodity-v2.0.0 (#7697)

Co-authored-by: deeleeramone <>

* update uv.lock (#7698)

Co-authored-by: deeleeramone <>

* update uv.lock (#7699)

Co-authored-by: deeleeramone <>

* update uv.lock (#7700)

Co-authored-by: deeleeramone <>

* [Release] `openbb-econometrics-v2.0.0` (#7701)

* update uv.lock

* update pyproject.toml

---------

Co-authored-by: deeleeramone <>

* update uv.lock (#7703)

Co-authored-by: deeleeramone <>

* update uv.lock (#7702)

Co-authored-by: deeleeramone <>

* update uv.lock (#7704)

Co-authored-by: deeleeramone <>

* update uv.lock (#7705)

Co-authored-by: deeleeramone <>

* update uv.lock (#7706)

Co-authored-by: deeleeramone <>

* [V5] Fix a Number of V5 Bugs (#7707)

* fix a number of v5 bugs

* fix lint error

* more lint

* fixes for quantitative, technical, charting, famafrench for version bumps

---------

Co-authored-by: deeleeramone <>

* update uv.lock (#7709)

Co-authored-by: deeleeramone <>

* update uv.lock (#7708)

Co-authored-by: deeleeramone <>

* update uv.lock (#7710)

Co-authored-by: deeleeramone <>

* update uv.lock (#7711)

Co-authored-by: deeleeramone <>

* [Release] `openbb-cboe-v2.0.0` (#7713)

Co-authored-by: deeleeramone <>

* update uv.lock (#7714)

Co-authored-by: deeleeramone <>

* update uv.lock (#7717)

Co-authored-by: deeleeramone <>

* [Release] `openbb-ecb-v2.0.0` (#7715)

* update uv.lock

* update uv.lock

---------

Co-authored-by: deeleeramone <>

* update uv.lock (#7718)

Co-authored-by: deeleeramone <>

* update uv.lock (#7719)

Co-authored-by: deeleeramone <>

* update uv.lock (#7720)

Co-authored-by: deeleeramone <>

* add missing publish-openbb-fred.yml to repo

* update uv.lock (#7723)

Co-authored-by: deeleeramone <>

* update uv.lock (#7722)

Co-authored-by: deeleeramone <>

* update uv.lock (#7716)

Co-authored-by: deeleeramone <>

* update uv.lock (#7724)

Co-authored-by: deeleeramone <>

* update uv.lock (#7726)

Co-authored-by: deeleeramone <>

* [Release] `openbb-fred-v2.0.0` (#7725)

* update uv.lock

* fix tests and dependencies

* fix test_fred_fetchers

---------

Co-authored-by: deeleeramone <>

* [Release] `openbb-imf-v3.0.0` (#7727)

* update uv.lock

* fix tests and dependencies

* fix test_fred_fetchers

* bump openbb-imf version to 3.0.0

---------

Co-authored-by: deeleeramone <>

* update uv.lock (#7729)

Co-authored-by: deeleeramone <>

* update uv.lock (#7728)

Co-authored-by: deeleeramone <>

* update uv.lock (#7730)

Co-authored-by: deeleeramone <>

* update uv.lock (#7731)

Co-authored-by: deeleeramone <>

* update uv.lock (#7732)

Co-authored-by: deeleeramone <>

* update uv.lock (#7733)

Co-authored-by: deeleeramone <>

* cookiecutter pyproject and lock

* update pyproject.toml (#7734)

Co-authored-by: deeleeramone <>

* update pyproject.toml (#7735)

Co-authored-by: deeleeramone <>

* update uv.lock (#7736)

Co-authored-by: deeleeramone <>

* fix some sec issues, allegedly (#7737)

Co-authored-by: deeleeramone <>

* update uv.lock (#7738)

Co-authored-by: deeleeramone <>

* update main pyproject.toml

* lint fixes

* update assets (#7739)

Co-authored-by: deeleeramone <>

* [Release] `openbb-v5.0.0` (#7740)

* update assets

* add missing workflow

---------

Co-authored-by: deeleeramone <>

---------

Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: deeleeramone <>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: Dex <i@dex.moe>
Co-authored-by: Monte Hoover <monte.b.hoover@gmail.com>
Co-authored-by: Boris Li <65254053+BorisQuanLi@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: Lucas Zimmermann <lucaszmayer@gmail.com>
2026-09-29 14:45:53 +00:00

1021 lines
32 KiB
Python

"""Tests for openbb_cli.codegen.pydantic_gen — schema → Pydantic source."""
from __future__ import annotations
import pytest
from openbb_cli.codegen import pydantic_gen as pg
# --- Naming helpers ---
def test_safe_field_name_passes_through_valid_identifier():
assert pg.safe_field_name("symbol") == ("symbol", False)
def test_safe_field_name_replaces_invalid_chars():
assert pg.safe_field_name("X-API-Key") == ("X_API_Key", True)
def test_safe_field_name_prefixes_leading_digit_with_letter():
"""``f_`` (not ``_``) so Pydantic v2 accepts it — leading-underscore
field names are rejected with "must not use names with leading
underscores"."""
assert pg.safe_field_name("404") == ("f_404", True)
def test_safe_field_name_handles_empty_input():
safe, alias = pg.safe_field_name("")
assert safe == "field"
assert alias is True
def test_safe_field_name_strips_leading_dollar_for_socrata_soql_params():
"""``$select`` → ``select`` (with alias ``$select``) — the leading
underscore that ``re.sub`` would otherwise produce trips Pydantic's
"Fields must not use names with leading underscores" check."""
assert pg.safe_field_name("$select") == ("select", True)
def test_safe_field_name_strips_leading_underscore_from_already_underscore_name():
"""An already-underscore-prefixed name (rare in practice) loses the
underscore so the result is Pydantic-compatible."""
assert pg.safe_field_name("_internal") == ("internal", True)
def test_safe_field_name_appends_underscore_for_keyword():
assert pg.safe_field_name("class") == ("class_", True)
def test_safe_field_name_appends_underscore_for_pydantic_reserved():
assert pg.safe_field_name("model_config") == ("model_config_", True)
def test_class_name_from_camel_cases_dotted_path():
assert pg.class_name_from("equity.price.quote", "Data") == "EquityPriceQuoteData"
def test_class_name_from_drops_falsy_parts():
assert pg.class_name_from("", "law", None) == "Law" # type: ignore[arg-type]
def test_class_name_from_handles_only_special_chars():
assert pg.class_name_from("---") == "Anonymous"
def test_class_name_from_prefixes_leading_digit():
"""Names starting with a digit get an underscore prefix to be valid identifiers."""
out = pg.class_name_from("123start")
assert out.startswith("_")
assert out.isidentifier()
# --- schema_to_type primitive coverage ---
@pytest.mark.parametrize(
"schema,expected",
[
({"type": "string"}, "str"),
({"type": "integer"}, "int"),
({"type": "number"}, "float"),
({"type": "boolean"}, "bool"),
],
)
def test_schema_to_type_primitives(schema, expected):
nested: list = []
imports: set[str] = set()
out = pg.schema_to_type(
schema,
parent_class_name="P",
field_name="x",
nested_classes=nested,
imports=imports,
)
assert out == expected
def test_schema_to_type_string_date_format_emits_date_import():
nested: list = []
imports: set[str] = set()
out = pg.schema_to_type(
{"type": "string", "format": "date"},
parent_class_name="P",
field_name="x",
nested_classes=nested,
imports=imports,
)
assert out == "datetime.date"
assert "import datetime" in imports
def test_schema_to_type_string_datetime_format_emits_datetime_import():
imports: set[str] = set()
out = pg.schema_to_type(
{"type": "string", "format": "date-time"},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=imports,
)
assert out == "datetime.datetime"
assert "import datetime" in imports
def test_schema_to_type_unknown_type_falls_back_to_any():
imports: set[str] = set()
out = pg.schema_to_type(
{},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=imports,
)
assert out == "Any"
assert "from typing import Any" in imports
def test_schema_to_type_treats_non_dict_as_any():
"""Defensive: a stray list / string in the schema doesn't crash."""
imports: set[str] = set()
out = pg.schema_to_type(
"not-a-schema",
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=imports,
)
assert out == "Any"
def test_schema_to_type_ref_cycle_collapses_to_dict():
"""A ``$ref`` left over from cycle detection becomes ``dict[str, Any]``."""
imports: set[str] = set()
out = pg.schema_to_type(
{"$ref": "#/components/schemas/Tree"},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=imports,
)
assert out == "dict[str, Any]"
# --- enum / const ---
def test_schema_to_type_enum_returns_literal_with_typing_import():
"""``enum`` resolves to ``Literal[...]`` — ``generate_class`` later
appends ``| None`` for optional fields (default=None) so the field
accepts the choices or the omit/None case (no filter applied)."""
imports: set[str] = set()
out = pg.schema_to_type(
{"type": "string", "enum": ["buy", "sell"]},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=imports,
)
assert out == "Literal['buy', 'sell']"
assert "from typing import Literal" in imports
def test_schema_to_type_enum_emits_literal_when_type_omitted():
"""Spec authors sometimes omit ``type`` next to ``enum``; the values
drive the Literal regardless."""
imports: set[str] = set()
out = pg.schema_to_type(
{"enum": [1, 2, 3]},
parent_class_name="P",
field_name="n",
nested_classes=[],
imports=imports,
)
assert out == "Literal[1, 2, 3]"
def test_schema_to_type_const_returns_single_member_literal():
imports: set[str] = set()
out = pg.schema_to_type(
{"type": "string", "const": "fred"},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=imports,
)
assert out == "Literal['fred']"
def test_schema_to_type_const_emits_literal_from_value_alone():
"""``const`` without an explicit ``type`` still emits ``Literal[<value>]``."""
imports: set[str] = set()
out = pg.schema_to_type(
{"const": 42},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=imports,
)
assert out == "Literal[42]"
# --- arrays ---
def test_schema_to_type_array_of_strings():
out = pg.schema_to_type(
{"type": "array", "items": {"type": "string"}},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=set(),
)
assert out == "list[str]"
def test_schema_to_type_array_with_no_items_falls_back_to_any():
out = pg.schema_to_type(
{"type": "array"},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=set(),
)
assert out == "list[Any]"
# --- unions ---
def test_schema_to_type_optional_collapses_to_pipe_none():
out = pg.schema_to_type(
{"anyOf": [{"type": "string"}, {"type": "null"}]},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=set(),
)
assert out == "str | None"
def test_schema_to_type_union_of_two_types():
out = pg.schema_to_type(
{"anyOf": [{"type": "string"}, {"type": "integer"}]},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=set(),
)
assert out == "str | int"
def test_schema_to_type_union_dedupes_repeated_branches():
"""``anyOf: [str, str]`` → ``str``, not ``str | str``."""
out = pg.schema_to_type(
{"anyOf": [{"type": "string"}, {"type": "string"}]},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=set(),
)
assert out == "str"
def test_schema_to_type_union_only_null_falls_back_to_any():
out = pg.schema_to_type(
{"anyOf": [{"type": "null"}]},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=set(),
)
assert out == "Any"
def test_schema_to_type_oneof_treated_same_as_anyof():
out = pg.schema_to_type(
{"oneOf": [{"type": "string"}, {"type": "null"}]},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=set(),
)
assert out == "str | None"
# --- nested objects ---
def test_schema_to_type_object_with_properties_creates_nested_class():
nested: list = []
out = pg.schema_to_type(
{
"type": "object",
"properties": {"name": {"type": "string"}},
"title": "Inner",
},
parent_class_name="Outer",
field_name="security",
nested_classes=nested,
imports=set(),
)
assert out == "Inner"
assert len(nested) == 1
assert nested[0].name == "Inner"
assert "name: str | None" in nested[0].source
def test_schema_to_type_object_without_title_derives_name_from_parent_field():
"""Anonymous nested object names come from ``<parent><field>`` Camel."""
nested: list = []
out = pg.schema_to_type(
{"type": "object", "properties": {"v": {"type": "integer"}}},
parent_class_name="Wrapper",
field_name="payload",
nested_classes=nested,
imports=set(),
)
assert out == "WrapperPayload"
assert nested[0].name == "WrapperPayload"
def test_schema_to_type_open_object_falls_back_to_dict_any():
"""``additionalProperties: true`` with no properties → ``dict[str, Any]``."""
imports: set[str] = set()
out = pg.schema_to_type(
{"type": "object", "additionalProperties": True},
parent_class_name="P",
field_name="x",
nested_classes=[],
imports=imports,
)
assert out == "dict[str, Any]"
def test_schema_to_type_typed_additional_properties_keeps_value_type():
"""``additionalProperties: {"type": "number"}`` → ``dict[str, float]``."""
out = pg.schema_to_type(
{"type": "object", "additionalProperties": {"type": "number"}},
parent_class_name="P",
field_name="coeffs",
nested_classes=[],
imports=set(),
)
assert out == "dict[str, float]"
def test_schema_to_type_nested_typed_additional_properties():
"""``dict[str, dict[str, float]]`` — confidence-interval style."""
out = pg.schema_to_type(
{
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {"type": "number"},
},
},
parent_class_name="P",
field_name="conf_int",
nested_classes=[],
imports=set(),
)
assert out == "dict[str, dict[str, float]]"
# --- generate_class ---
def test_generate_class_required_and_optional_fields():
schema = {
"type": "object",
"required": ["symbol"],
"properties": {
"symbol": {"type": "string", "description": "Ticker."},
"limit": {"type": "integer", "default": 5, "description": "Page size."},
"label": {"type": "string", "description": "Pretty label."},
},
}
cls = pg.generate_class(schema, class_name="Quote")
src = cls.source
assert "class Quote(BaseModel):" in src
assert "symbol: str = Field(description='Ticker.')" in src
assert "limit: int | None = Field(default=5, description='Page size.')" in src
assert "label: str | None = Field(default=None, description='Pretty label.')" in src
def test_generate_class_normalized_nullable_fields_keep_format_and_enum():
"""The 3.1 chain end-to-end: ``expand_type_arrays`` copies siblings into
``anyOf`` variants, so nullable date/enum fields type as ``datetime.date``
/ ``Literal`` — not ``str``. Guards against a bare-variant normalizer
(one that emits ``{"type": t}`` only) ever reappearing upstream."""
from openbb_cli.dispatchers.openapi_schema import expand_type_arrays
schema = expand_type_arrays(
{
"type": "object",
"properties": {
"date": {"type": ["string", "null"], "format": "date"},
"rating": {"type": ["string", "null"], "enum": ["AAA", "AA"]},
"close": {"type": ["number", "null"]},
},
}
)
cls = pg.generate_class(schema, class_name="Row")
src = cls.source
assert "date: datetime.date | None" in src
assert "rating: Literal['AAA', 'AA'] | None" in src
assert "close: float | None" in src
assert "import datetime" in cls.collect_imports()
def test_generate_class_field_alias_for_dotted_property_name():
schema = {
"type": "object",
"properties": {"X-API-Key": {"type": "string"}},
}
cls = pg.generate_class(schema, class_name="Headers")
assert "X_API_Key:" in cls.source
assert "alias='X-API-Key'" in cls.source
def test_generate_class_no_properties_emits_pass_body():
cls = pg.generate_class({"type": "object"}, class_name="Empty")
assert " pass" in cls.source
def test_generate_class_uses_provided_docstring_summary():
cls = pg.generate_class(
{"type": "object", "properties": {"x": {"type": "string"}}},
class_name="C",
docstring="Custom docs.",
)
# Summary appears at the top of the Numpy-style block
assert '"""Custom docs.' in cls.source
def test_generate_class_falls_back_to_class_name_when_no_docstring():
"""Summary defaults to the bare class name when the schema has none."""
cls = pg.generate_class(
{"type": "object", "properties": {"x": {"type": "string"}}},
class_name="C",
)
assert '"""C.' in cls.source
def test_generate_class_emits_numpy_parameters_block():
"""Each field appears in the Numpy ``Parameters`` block with type + description."""
schema = {
"type": "object",
"required": ["symbol"],
"properties": {
"symbol": {"type": "string", "description": "Ticker."},
"limit": {"type": "integer", "default": 5, "description": "Page size."},
},
}
cls = pg.generate_class(schema, class_name="Quote")
src = cls.source
assert "Parameters" in src
assert "----------" in src
# Required field: bare type
assert "symbol : str" in src
# Optional field: ``, optional`` suffix + default in description
assert "limit : int, optional" in src
assert "(default: 5)" in src
def test_generate_class_docstring_summary_gets_trailing_period():
"""A summary without a trailing ``.`` has one added — matches D415."""
cls = pg.generate_class(
{"type": "object", "properties": {"x": {"type": "string"}}},
class_name="C",
docstring="Custom docs",
)
assert '"""Custom docs.' in cls.source
def test_generate_class_docstring_field_with_no_description_omits_body_line():
"""A field with no description renders as ``name : type`` only."""
cls = pg.generate_class(
{"type": "object", "properties": {"x": {"type": "string"}}},
class_name="C",
)
block = cls.source.split('"""')[1]
assert "x : str, optional" in block
lines = block.split("\n")
x_idx = next(i for i, line in enumerate(lines) if "x : str" in line)
next_line = lines[x_idx + 1] if x_idx + 1 < len(lines) else ""
assert next_line.strip() != "."
def test_generate_class_handles_nested_object_via_separate_class():
"""A plain nested object becomes its own ``BaseModel`` class so Pydantic
can recursively validate the runtime row."""
schema = {
"type": "object",
"properties": {
"inner": {
"type": "object",
"title": "Inner",
"properties": {"v": {"type": "integer"}},
}
},
}
cls = pg.generate_class(schema, class_name="Outer")
assert cls.nested
assert cls.nested[0].name == "Inner"
assert "inner: Inner | None" in cls.source
def test_generate_class_handles_deep_nesting_via_flatten():
"""Nested → nested objects all show up in topological order in ``flatten``."""
schema = {
"type": "object",
"properties": {
"a": {
"type": "object",
"title": "A",
"properties": {
"b": {
"type": "object",
"title": "B",
"properties": {"v": {"type": "integer"}},
}
},
}
},
}
cls = pg.generate_class(schema, class_name="Root")
flat = cls.flatten()
names = [c.name for c in flat]
# B comes before A because A depends on B; Root last because it depends on A
assert names.index("B") < names.index("A")
assert names.index("A") < names.index("Root")
def test_generate_class_collect_imports_unions_descendants():
schema = {
"type": "object",
"properties": {
"when": {"type": "string", "format": "date"},
"limit": {"type": "integer"},
},
}
cls = pg.generate_class(schema, class_name="C")
imports = cls.collect_imports()
assert "import datetime" in imports
assert "from pydantic import BaseModel, Field" in imports
def test_generate_class_array_of_objects_emits_nested_item_class():
schema = {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Item",
"properties": {"id": {"type": "integer"}},
},
}
},
}
cls = pg.generate_class(schema, class_name="List")
assert any(c.name == "Item" for c in cls.nested)
assert "items: list[Item]" in cls.source
# --- render_module ---
def test_render_module_emits_imports_then_classes_in_topological_order():
schema = {
"type": "object",
"title": "Outer",
"properties": {
"inner": {
"type": "object",
"title": "Inner",
"properties": {"x": {"type": "integer"}},
}
},
}
cls = pg.generate_class(schema, class_name="Outer")
rendered = pg.render_module(cls, module_docstring="Generated module.")
# Docstring at the top (single-line form is fine, just must be present first)
assert rendered.lstrip().startswith(("'", '"'))
assert "Generated module." in rendered.split("\n", 3)[0]
# Inner class defined before Outer
assert rendered.index("class Inner") < rendered.index("class Outer")
# Pydantic import present
assert "from pydantic import BaseModel, Field" in rendered
def test_render_module_compiles_to_valid_python():
"""The emitted source actually parses and produces working Pydantic models."""
import ast
import importlib.util
import sys
import textwrap
schema = {
"type": "object",
"required": ["symbol"],
"properties": {
"symbol": {"type": "string"},
"side": {"type": "string", "enum": ["buy", "sell"]},
"qty": {"type": "integer", "default": 1},
"tags": {"type": "array", "items": {"type": "string"}},
"when": {"type": "string", "format": "date-time"},
"details": {
"type": "object",
"title": "Details",
"properties": {"note": {"type": "string"}},
},
"freeform": {"anyOf": [{"type": "string"}, {"type": "integer"}]},
},
}
cls = pg.generate_class(schema, class_name="Order")
rendered = pg.render_module(cls)
# 1. parses
ast.parse(rendered)
# 2. evaluating it produces a real Pydantic class with the expected fields
spec = importlib.util.spec_from_loader("generated_test_mod", loader=None)
assert spec is not None
mod = importlib.util.module_from_spec(spec)
sys.modules["generated_test_mod"] = mod
try:
exec(textwrap.dedent(rendered), mod.__dict__) # noqa: S102 — controlled source
Order = mod.Order
instance = Order(symbol="AAPL", side="buy", details={"note": "x"})
assert instance.symbol == "AAPL"
assert instance.side == "buy"
assert instance.qty == 1
assert instance.details.note == "x"
finally:
sys.modules.pop("generated_test_mod", None)
@pytest.mark.parametrize(
"default,expected",
[
(True, "True"),
(False, "False"),
(42, "42"),
(1.5, "1.5"),
("text", "'text'"),
(None, "None"),
([1, 2], "[1, 2]"),
((1, 2), "(1, 2)"),
({"k": "v"}, "{'k': 'v'}"),
(object(), "<"), # Falls through to repr() for unknown types
],
)
def test_render_field_default_covers_every_branch(default, expected):
"""Every literal branch in ``render_field_default`` round-trips correctly."""
out = pg.render_field_default(default)
assert expected in out
def test_python_string_literal_handles_multiline_text():
"""Multi-line text uses triple-quoted form."""
out = pg._python_string_literal("line one\nline two")
assert out.startswith('"""')
assert out.endswith('"""')
assert "line one" in out
assert "line two" in out
def test_python_string_literal_escapes_embedded_triple_quotes():
"""A description containing ``\"\"\"`` mustn't break the literal."""
out = pg._python_string_literal('contains """ inside\nmore text')
# The triple quotes inside the string are escaped, not closed
assert out.count('"""') == 2 # only the opening and closing
def test_generate_class_optional_field_emits_default_none_with_empty_description():
"""Optional field with no spec text emits ``description=''`` (not omitted) so
openbb-core's DocstringGenerator doesn't render the literal string ``"None"``."""
schema = {"type": "object", "properties": {"x": {"type": "string"}}}
cls = pg.generate_class(schema, class_name="C")
assert "x: str | None = Field(default=None, description='')" in cls.source
def test_generate_class_uses_triple_quoted_docstring_for_multiline():
"""A multi-line docstring lands as a triple-quoted block."""
cls = pg.generate_class(
{"type": "object", "properties": {"x": {"type": "string"}}},
class_name="C",
docstring="line one\nline two",
)
assert '"""' in cls.source
assert "line two" in cls.source
# --- render_function_docstring ---
def test_render_function_docstring_minimum_summary_only():
out = pg.render_function_docstring("Fetch the data")
assert out == ' """Fetch the data.\n """'
def test_render_function_docstring_summary_keeps_existing_period():
out = pg.render_function_docstring("Already punctuated.")
assert "Already punctuated." in out
# No double period
assert "..\n" not in out
def test_render_function_docstring_emits_parameters_section():
out = pg.render_function_docstring(
"Send a request",
parameters=[
("query", "QueryParams", "Validated query parameters."),
("credentials", "dict[str, str] | None", None),
],
)
assert "Parameters" in out
assert "----------" in out
assert "query : QueryParams" in out
assert " Validated query parameters." in out
assert "credentials : dict[str, str] | None" in out
cred_idx = out.index("credentials :")
after = out[cred_idx:]
next_line = after.split("\n", 2)[1] if "\n" in after else ""
assert next_line.strip() != "."
def test_render_function_docstring_emits_returns_section():
out = pg.render_function_docstring(
"Build something",
returns=("BillData", "The fetched bill record."),
)
assert "Returns" in out
assert "-------" in out
assert "BillData" in out
assert " The fetched bill record." in out
def test_render_function_docstring_returns_section_with_no_description():
out = pg.render_function_docstring(
"Build something",
returns=("int", None),
)
assert "Returns" in out
assert "int" in out
assert " ." not in out
def test_render_function_docstring_custom_indent_for_nested_definitions():
"""Method docstrings indent by 8 spaces (4 for class + 4 for method body)."""
out = pg.render_function_docstring("Nested method.", indent=" ")
assert out.startswith(' """')
# --- _annotation_for_docstring ---
def test_annotation_for_docstring_strips_pipe_none():
assert pg._annotation_for_docstring("str | None") == ("str", True)
def test_annotation_for_docstring_keeps_required_type_intact():
assert pg._annotation_for_docstring("list[int]") == ("list[int]", False)
def test_render_module_against_real_openbb_response_schema():
"""End-to-end: shape resembling a real OBBject inner data class."""
import ast
# Truncated copy of OLSRegressionResults's properties
schema = {
"type": "object",
"title": "OLSRegressionResults",
"required": ["params", "rsquared", "nobs"],
"properties": {
"params": {
"type": "object",
"additionalProperties": {"type": "number"},
"description": "Coefficient estimates.",
},
"rsquared": {"type": "number", "description": "R-squared."},
"nobs": {"type": "integer", "description": "Observation count."},
"fvalue": {
"anyOf": [{"type": "number"}, {"type": "null"}],
"description": "F-statistic.",
},
},
}
cls = pg.generate_class(schema, class_name="OLSRegressionResults")
rendered = pg.render_module(cls)
ast.parse(rendered)
assert "rsquared: float = Field(description='R-squared.')" in rendered
assert "fvalue: float | None" in rendered
def test_build_field_call_wraps_when_single_line_exceeds_budget():
"""Lines 355-356: long Field args force the multi-line wrap path."""
long_description = "This is a deliberately verbose description " * 4
out = pg._build_field_call(
description=long_description,
default=None,
has_default=False,
required=True,
alias=None,
leading_width=20,
)
assert out.startswith("Field(\n ")
assert out.endswith(",\n )")
def test_field_falls_back_to_example_when_no_description():
"""Schema with only ``example`` (no ``description``) gets ``"Example: <val>"``
so the rendered Field / docstring shows useful text instead of ``None``."""
schema = {
"type": "object",
"properties": {"auctionStatus": {"type": "string", "example": "Results"}},
}
cls = pg.generate_class(schema, class_name="C")
src = cls.source
assert "description='Example: Results.'" in src
# And the docstring section also picks up the example
block = src.split('"""')[1]
assert "Example: Results" in block
def test_field_keeps_description_over_example_when_both_present():
schema = {
"type": "object",
"properties": {
"x": {"type": "string", "description": "Real description.", "example": "EX"}
},
}
cls = pg.generate_class(schema, class_name="C")
assert "Real description." in cls.source
assert "Example: EX" not in cls.source
def test_optional_enum_field_emits_literal_with_optional_none_suffix():
"""``{type: string, enum: [P, S]}`` becomes ``Literal['P', 'S'] | None``
so Pydantic enforces the choices at construction time. ``None``
(the default) means "no filter applied"; passing ``'P'`` / ``'S'``
constrains; passing anything else raises. The openbb-core renderer
fix in the same change set keeps ``Literal[...] | None`` from
collapsing to the bogus ``Optional[None]`` in docstrings."""
schema = {
"type": "object",
"properties": {
"operationDirection": {
"type": "string",
"enum": ["P", "S"],
"example": "P",
}
},
}
cls = pg.generate_class(schema, class_name="Auction")
src = cls.source
assert "operationDirection: Literal['P', 'S'] | None" in src
# Choices still surface in the description for user-facing context.
assert "Choices: P, S" in src
assert "Example: P" in src
def test_field_with_no_description_no_example_emits_empty_description():
"""No spec text -> ``description=''``, not omitted. Empty string keeps
openbb-core's DocstringGenerator from rendering the literal ``"None"``."""
schema = {
"type": "object",
"properties": {"numDealers": {"type": "integer"}},
}
cls = pg.generate_class(schema, class_name="C")
assert "description=''" in cls.source
assert "None" not in cls.source.split("class C")[1].split("\n", 5)[0]
def test_render_module_appends_period_to_docstring_summary():
"""Line 681: a docstring without trailing punctuation gets a period."""
schema = {"type": "object", "properties": {"x": {"type": "integer"}}}
cls = pg.generate_class(schema, class_name="P")
rendered = pg.render_module(cls, module_docstring="No trailing period")
first_line = rendered.split("\n", 1)[0]
assert first_line == '"""No trailing period."""'
# --- _enum_primitive ---
def test_enum_primitive_renders_string_values_as_literal():
imports: set[str] = set()
assert pg._enum_primitive(["A", "B"], None, imports) == "Literal['A', 'B']"
assert "from typing import Literal" in imports
def test_enum_primitive_renders_numeric_values_as_literal():
imports: set[str] = set()
assert pg._enum_primitive([1, 2, 3], None, imports) == "Literal[1, 2, 3]"
def test_enum_primitive_renders_boolean_values_as_literal():
imports: set[str] = set()
assert pg._enum_primitive([True, False], None, imports) == "Literal[True, False]"
def test_enum_primitive_falls_back_to_any_for_empty_choice_set():
"""``enum: []`` carries no information — collapse to ``Any`` rather
than emit a ``Literal[]`` that Pydantic can't construct."""
imports: set[str] = set()
out = pg._enum_primitive([], None, imports)
assert out == "Any"
assert "from typing import Any" in imports
# --- _build_field_call empty branch ---
def test_build_field_call_returns_empty_when_no_metadata_to_emit():
"""A required field with no description / alias yields no ``Field(...)``
so the caller drops the trailing ``=`` entirely."""
out = pg._build_field_call(
description=None,
default=None,
has_default=False,
required=True,
alias=None,
leading_width=10,
)
assert out == ""
# --- _nested_object_breakout ---
def test_nested_object_breakout_descends_into_oneof_variant():
"""``{oneOf: [{properties: {...}}]}`` items expose their inner fields."""
prop = {
"items": {
"oneOf": [
{"properties": {"flag": {"type": "string"}, "id": {"type": "integer"}}}
]
}
}
out = pg._nested_object_breakout(prop)
assert "flag (str)" in out
assert "id (int)" in out
assert out.startswith("Inner item fields:")
def test_nested_object_breakout_handles_non_dict_inner_schema():
"""A property whose inner schema is a stray scalar still names the field
in the breakout — it just can't render a type label for it."""
prop = {"properties": {"a": "not-a-dict", "b": {"type": "integer"}}}
out = pg._nested_object_breakout(prop)
assert "a, b (int)" in out
def test_nested_object_breakout_returns_empty_for_primitive_field():
"""No nested properties anywhere → no breakout to render."""
assert pg._nested_object_breakout({"type": "string"}) == ""
# --- _quick_schema_type ---
def test_quick_schema_type_returns_str_for_enum():
"""An ``enum`` schema labels the field as ``str`` regardless of declared type."""
assert pg._quick_schema_type({"enum": ["A", "B"]}) == "str"
def test_quick_schema_type_renders_array_with_inner_type():
assert pg._quick_schema_type({"type": "array", "items": {"type": "integer"}}) == (
"list[int]"
)
def test_quick_schema_type_array_without_items_falls_back_to_any():
assert pg._quick_schema_type({"type": "array"}) == "list[Any]"
def test_quick_schema_type_recurses_into_nested_array():
assert (
pg._quick_schema_type(
{"type": "array", "items": {"type": "array", "items": {"type": "string"}}}
)
== "list[list[str]]"
)
def test_quick_schema_type_renders_date_format():
assert pg._quick_schema_type({"type": "string", "format": "date"}) == "date"
def test_quick_schema_type_renders_datetime_format():
assert pg._quick_schema_type({"type": "string", "format": "date-time"}) == (
"datetime"
)
def test_quick_schema_type_unknown_type_falls_back_to_any():
"""A schema with no ``type`` and no other handled keys collapses to ``Any``."""
assert pg._quick_schema_type({}) == "Any"