mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
* [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>
1619 lines
54 KiB
Python
1619 lines
54 KiB
Python
"""Test the Controller utils."""
|
|
|
|
import argparse
|
|
from pathlib import Path
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
from openbb_cli.controllers.utils import (
|
|
check_file_type_saved,
|
|
check_non_negative,
|
|
check_positive,
|
|
get_flair_and_username,
|
|
get_user_agent,
|
|
parse_and_split_input,
|
|
parse_unknown_args_to_dict,
|
|
print_goodbye,
|
|
remove_file,
|
|
return_colored_value,
|
|
suppress_stdout,
|
|
validate_register_key,
|
|
welcome_message,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_session():
|
|
"""Mock the session and its dependencies."""
|
|
with patch("openbb_cli.controllers.utils.session") as mock_session:
|
|
mock_session.console.print = MagicMock()
|
|
mock_session.settings.VERSION = "1.0"
|
|
mock_session.settings.FLAIR = "rocket"
|
|
yield mock_session
|
|
|
|
|
|
def test_remove_file_existing_file():
|
|
"""Test removing an existing file."""
|
|
with patch("os.path.isfile", return_value=True), patch("os.remove") as mock_remove:
|
|
assert remove_file(Path("/path/to/file"))
|
|
mock_remove.assert_called_once()
|
|
|
|
|
|
def test_remove_file_directory():
|
|
"""Test removing a directory."""
|
|
with (
|
|
patch("os.path.isfile", return_value=False),
|
|
patch("os.path.isdir", return_value=True),
|
|
patch("shutil.rmtree") as mock_rmtree,
|
|
):
|
|
assert remove_file(Path("/path/to/directory"))
|
|
mock_rmtree.assert_called_once()
|
|
|
|
|
|
def test_remove_file_failure(mock_session):
|
|
"""Test removing a file that fails."""
|
|
with (
|
|
patch("os.path.isfile", return_value=True),
|
|
patch("os.remove", side_effect=Exception("Error")),
|
|
):
|
|
assert not remove_file(Path("/path/to/file"))
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_print_goodbye(mock_session):
|
|
"""Test printing the goodbye message."""
|
|
print_goodbye()
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_parse_and_split_input():
|
|
"""Test parsing and splitting user input."""
|
|
user_input = "ls -f /home/user/docs/document.xlsx"
|
|
result = parse_and_split_input(user_input, [])
|
|
assert "ls" in result[0]
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"input_command, expected_output",
|
|
[
|
|
("/", ["home"]),
|
|
("ls -f /path/to/file.txt", ["ls -f ", "path", "to", "file.txt"]),
|
|
("rm -f /home/user/docs", ["rm -f ", "home", "user", "docs"]),
|
|
],
|
|
)
|
|
def test_parse_and_split_input_special_cases(input_command, expected_output):
|
|
"""Test parsing and splitting user input with special cases."""
|
|
result = parse_and_split_input(input_command, [])
|
|
assert result == expected_output
|
|
|
|
|
|
def test_welcome_message(mock_session):
|
|
"""Test printing the welcome message."""
|
|
welcome_message()
|
|
mock_session.console.print.assert_called_with(
|
|
"\nWelcome to OpenBB Platform CLI v1.0"
|
|
)
|
|
|
|
|
|
def test_get_flair_and_username(mock_session):
|
|
"""Test getting the flair and username."""
|
|
result = get_flair_and_username()
|
|
assert "rocket" in result
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"value, expected",
|
|
[
|
|
("10", 10),
|
|
("0", 0),
|
|
("-1", pytest.raises(argparse.ArgumentTypeError)),
|
|
("text", pytest.raises(ValueError)),
|
|
],
|
|
)
|
|
def test_check_non_negative(value, expected):
|
|
"""Test checking for a non-negative value."""
|
|
if isinstance(expected, int):
|
|
assert check_non_negative(value) == expected
|
|
else:
|
|
with expected:
|
|
check_non_negative(value)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"value, expected",
|
|
[
|
|
("1", 1),
|
|
("0", pytest.raises(argparse.ArgumentTypeError)),
|
|
("-1", pytest.raises(argparse.ArgumentTypeError)),
|
|
("text", pytest.raises(ValueError)),
|
|
],
|
|
)
|
|
def test_check_positive(value, expected):
|
|
"""Test checking for a positive value."""
|
|
if isinstance(expected, int):
|
|
assert check_positive(value) == expected
|
|
else:
|
|
with expected:
|
|
check_positive(value)
|
|
|
|
|
|
def test_get_user_agent():
|
|
"""Test getting the user agent."""
|
|
result = get_user_agent()
|
|
assert result.startswith("Mozilla/5.0")
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"value, expected_color",
|
|
[
|
|
("10.5", "green"),
|
|
("-3.2", "red"),
|
|
("0", "yellow"),
|
|
("0.0", "yellow"),
|
|
("no numbers here", ""),
|
|
("abc 1 def 2", ""),
|
|
],
|
|
)
|
|
def test_return_colored_value(value, expected_color):
|
|
"""Test return_colored_value applies correct color."""
|
|
result = return_colored_value(value)
|
|
if expected_color:
|
|
assert f"[{expected_color}]" in result
|
|
else:
|
|
assert "[green]" not in result
|
|
assert "[red]" not in result
|
|
|
|
|
|
import sys
|
|
|
|
|
|
def test_suppress_stdout():
|
|
"""Test that suppress_stdout redirects stdout and stderr."""
|
|
original_out = sys.stdout
|
|
original_err = sys.stderr
|
|
with suppress_stdout():
|
|
assert sys.stdout is not original_out
|
|
assert sys.stderr is not original_err
|
|
assert sys.stdout is original_out
|
|
assert sys.stderr is original_err
|
|
|
|
|
|
from openbb_cli.controllers.utils import bootup
|
|
|
|
|
|
def test_bootup_runs_without_error(mock_session):
|
|
"""Test that bootup completes without raising."""
|
|
bootup()
|
|
|
|
|
|
from openbb_cli.controllers.utils import first_time_user
|
|
|
|
|
|
def test_first_time_user_empty_env(mock_session, tmp_path):
|
|
"""Test first_time_user returns True for empty env file."""
|
|
env_file = tmp_path / ".env"
|
|
env_file.write_text("")
|
|
with patch("openbb_cli.controllers.utils.ENV_FILE_SETTINGS", env_file):
|
|
result = first_time_user()
|
|
assert result is True
|
|
mock_session.settings.set_item.assert_called_once_with("PREVIOUS_USE", True)
|
|
|
|
|
|
def test_first_time_user_non_empty_env(mock_session, tmp_path):
|
|
"""Test first_time_user returns False for non-empty env file."""
|
|
env_file = tmp_path / ".env"
|
|
env_file.write_text("KEY=VALUE\n")
|
|
with patch("openbb_cli.controllers.utils.ENV_FILE_SETTINGS", env_file):
|
|
result = first_time_user()
|
|
assert result is False
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"args, expected",
|
|
[
|
|
(["--key", "value"], {"key": "value"}),
|
|
(["--a", "1", "--b", "hello"], {"a": 1, "b": "hello"}),
|
|
(["--flag"], {}),
|
|
(None, {}),
|
|
([], {}),
|
|
],
|
|
)
|
|
def test_parse_unknown_args_to_dict_basic(args, expected, mock_session):
|
|
"""Test basic key-value parsing and edge cases."""
|
|
result = parse_unknown_args_to_dict(args)
|
|
assert result == expected
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"args, expected",
|
|
[
|
|
(["--num", "42"], {"num": 42}),
|
|
(["--pi", "3.14"], {"pi": 3.14}),
|
|
(["--items", "[1, 2, 3]"], {"items": [1, 2, 3]}),
|
|
(["--mapping", "{'a': 1}"], {"mapping": {"a": 1}}),
|
|
(["--bool", "True"], {"bool": True}),
|
|
(["--plain", "not-a-literal"], {"plain": "not-a-literal"}),
|
|
],
|
|
)
|
|
def test_parse_unknown_args_to_dict_literal_eval(args, expected, mock_session):
|
|
"""Test that ast.literal_eval correctly parses typed values."""
|
|
result = parse_unknown_args_to_dict(args)
|
|
assert result == expected
|
|
|
|
|
|
def test_parse_unknown_args_to_dict_missing_value(mock_session):
|
|
"""Test that a trailing --flag with no value prints a warning."""
|
|
result = parse_unknown_args_to_dict(["--orphan"])
|
|
assert result == {}
|
|
mock_session.console.print.assert_called_once()
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"key, should_raise",
|
|
[
|
|
("my_api_key", False),
|
|
("secret_123", False),
|
|
("OBB_KEY", True),
|
|
("my_OBB_key", True),
|
|
("OBB", True),
|
|
],
|
|
)
|
|
def test_validate_register_key(key, should_raise):
|
|
"""Test that keys containing 'OBB' are rejected."""
|
|
if should_raise:
|
|
with pytest.raises(argparse.ArgumentTypeError, match="OBB"):
|
|
validate_register_key(key)
|
|
else:
|
|
assert validate_register_key(key) == key
|
|
|
|
|
|
def test_check_file_type_saved_valid(mock_session):
|
|
"""Test valid filenames are accepted."""
|
|
checker = check_file_type_saved(valid_types=[".csv", ".json"])
|
|
assert checker("report.csv") == "report.csv"
|
|
assert checker("data.json") == "data.json"
|
|
assert checker("a.csv,b.json") == "a.csv,b.json"
|
|
|
|
|
|
def test_check_file_type_saved_invalid(mock_session):
|
|
"""Test invalid filenames are rejected with a warning."""
|
|
checker = check_file_type_saved(valid_types=[".csv"])
|
|
result = checker("report.xlsx")
|
|
assert result == ""
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_check_file_type_saved_empty(mock_session):
|
|
"""Test empty input returns empty string."""
|
|
checker = check_file_type_saved(valid_types=[".csv"])
|
|
assert checker("") == ""
|
|
assert checker() == ""
|
|
|
|
|
|
def test_check_file_type_saved_no_valid_types(mock_session):
|
|
"""Test that None valid_types returns empty string."""
|
|
checker = check_file_type_saved(valid_types=None)
|
|
assert checker("anything.csv") == ""
|
|
|
|
|
|
def test_compose_export_path_with_normal_directory(mock_session, tmp_path):
|
|
"""Builds ``<export_dir>/<timestamp>_<dir-segments>_<func>``."""
|
|
from openbb_cli.controllers.utils import compose_export_path
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
parent = tmp_path / "stocks"
|
|
sub = parent / "fundamentals"
|
|
sub.mkdir(parents=True)
|
|
result = compose_export_path("balance", str(sub))
|
|
assert result.parent == tmp_path
|
|
assert "stocks_fundamentals_balance" in result.name
|
|
|
|
|
|
def test_compose_export_path_collapses_openbb_cli_directory(mock_session, tmp_path):
|
|
"""When the parent dir is ``openbb_cli``, only the last path segment is used."""
|
|
from openbb_cli.controllers.utils import compose_export_path
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
fake_root = tmp_path / "openbb_cli" / "controllers"
|
|
fake_root.mkdir(parents=True)
|
|
result = compose_export_path("foo", str(fake_root))
|
|
assert "controllers_foo" in result.name
|
|
assert "openbb_cli" not in result.name
|
|
|
|
|
|
def test_ask_file_overwrite_when_overwrite_setting_enabled(mock_session, tmp_path):
|
|
"""``settings.FILE_OVERWRITE=True`` → no prompt, return (False, True)."""
|
|
from openbb_cli.controllers.utils import ask_file_overwrite
|
|
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
f = tmp_path / "a.txt"
|
|
f.write_text("x")
|
|
assert ask_file_overwrite(f) == (False, True)
|
|
|
|
|
|
def test_ask_file_overwrite_in_test_mode(mock_session, tmp_path):
|
|
"""``TEST_MODE=True`` short-circuits to (False, True)."""
|
|
from openbb_cli.controllers.utils import ask_file_overwrite
|
|
|
|
mock_session.settings.FILE_OVERWRITE = False
|
|
mock_session.settings.TEST_MODE = True
|
|
f = tmp_path / "a.txt"
|
|
f.write_text("x")
|
|
assert ask_file_overwrite(f) == (False, True)
|
|
|
|
|
|
def test_ask_file_overwrite_user_yes(mock_session, tmp_path):
|
|
"""User answers 'y' → file is unlinked and (True, True) is returned."""
|
|
from openbb_cli.controllers.utils import ask_file_overwrite
|
|
|
|
mock_session.settings.FILE_OVERWRITE = False
|
|
mock_session.settings.TEST_MODE = False
|
|
f = tmp_path / "a.txt"
|
|
f.write_text("x")
|
|
with patch("builtins.input", return_value="y"):
|
|
result = ask_file_overwrite(f)
|
|
assert result == (True, True)
|
|
assert not f.exists()
|
|
|
|
|
|
def test_ask_file_overwrite_user_no(mock_session, tmp_path):
|
|
"""User answers 'n' → file untouched, (True, False) returned."""
|
|
from openbb_cli.controllers.utils import ask_file_overwrite
|
|
|
|
mock_session.settings.FILE_OVERWRITE = False
|
|
mock_session.settings.TEST_MODE = False
|
|
f = tmp_path / "a.txt"
|
|
f.write_text("x")
|
|
with patch("builtins.input", return_value="n"):
|
|
result = ask_file_overwrite(f)
|
|
assert result == (True, False)
|
|
assert f.exists()
|
|
|
|
|
|
def test_ask_file_overwrite_missing_file(mock_session, tmp_path):
|
|
"""Missing file → no prompt, (False, True)."""
|
|
from openbb_cli.controllers.utils import ask_file_overwrite
|
|
|
|
mock_session.settings.FILE_OVERWRITE = False
|
|
mock_session.settings.TEST_MODE = False
|
|
f = tmp_path / "missing.txt"
|
|
assert ask_file_overwrite(f) == (False, True)
|
|
|
|
|
|
def test_request_invalid_method_raises():
|
|
"""Unknown HTTP method raises ValueError."""
|
|
from openbb_cli.controllers.utils import request
|
|
|
|
with pytest.raises(ValueError, match="Invalid method"):
|
|
request("https://example.com", method="bogus")
|
|
|
|
|
|
def test_request_adds_user_agent_when_missing(mock_session):
|
|
"""``request`` injects a User-Agent header when none is supplied."""
|
|
from openbb_cli.controllers.utils import request
|
|
|
|
mock_session.user.preferences.request_timeout = 5
|
|
with patch("openbb_cli.controllers.utils.requests") as req_mod:
|
|
req_mod.get.return_value = MagicMock(status_code=200)
|
|
request("https://example.com")
|
|
headers = req_mod.get.call_args[1]["headers"]
|
|
assert "User-Agent" in headers
|
|
|
|
|
|
def test_request_preserves_user_supplied_user_agent(mock_session):
|
|
"""Caller-provided User-Agent is not overwritten."""
|
|
from openbb_cli.controllers.utils import request
|
|
|
|
mock_session.user.preferences.request_timeout = 5
|
|
with patch("openbb_cli.controllers.utils.requests") as req_mod:
|
|
req_mod.post.return_value = MagicMock(status_code=200)
|
|
request(
|
|
"https://example.com",
|
|
method="post",
|
|
headers={"User-Agent": "custom"},
|
|
)
|
|
headers = req_mod.post.call_args[1]["headers"]
|
|
assert headers["User-Agent"] == "custom"
|
|
|
|
|
|
def test_system_clear_invokes_subprocess():
|
|
"""``system_clear`` runs the platform clear command via ``subprocess.run``."""
|
|
import os
|
|
|
|
from openbb_cli.controllers.utils import system_clear
|
|
|
|
with patch("openbb_cli.controllers.utils.subprocess.run") as run:
|
|
system_clear()
|
|
expected = "cls" if os.name == "nt" else "clear"
|
|
run.assert_called_once_with(expected, shell=True, check=False) # noqa: S604
|
|
|
|
|
|
def test_save_to_excel_creates_new_file(mock_session, tmp_path):
|
|
"""When the path doesn't exist yet, ``save_to_excel`` creates the workbook."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import save_to_excel
|
|
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
saved = tmp_path / "out.xlsx"
|
|
save_to_excel(df, saved, sheet_name="Sheet1")
|
|
assert saved.exists()
|
|
|
|
|
|
def test_handle_obbject_display_normal_path_uses_output_adapter(
|
|
mock_session, sample_df_helper
|
|
):
|
|
"""Non-chart, non-interactive path goes through the session's output adapter."""
|
|
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
obbject = MagicMock()
|
|
obbject.results = sample_df_helper
|
|
obbject.extra = {"command": "/equity/quote"}
|
|
obbject.chart = None
|
|
obbject.to_dataframe.return_value = sample_df_helper
|
|
|
|
with patch(
|
|
"openbb_cli.controllers.utils.extract_dataframe", return_value=sample_df_helper
|
|
):
|
|
handle_obbject_display(obbject)
|
|
mock_session.output_adapter.display.assert_called_once()
|
|
|
|
|
|
def test_handle_obbject_display_chart_path(mock_session):
|
|
"""``chart=True`` calls ``obbject.show()`` when a chart is present."""
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
obbject = MagicMock()
|
|
obbject.chart = MagicMock()
|
|
obbject.results = MagicMock()
|
|
obbject.extra = {}
|
|
obbject.show = MagicMock()
|
|
handle_obbject_display(obbject, chart=True)
|
|
obbject.show.assert_called_once()
|
|
|
|
|
|
def test_handle_obbject_display_chart_failure_logs(mock_session):
|
|
"""Chart display failure prints a console error but doesn't propagate."""
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
obbject = MagicMock()
|
|
obbject.chart = MagicMock()
|
|
obbject.results = MagicMock()
|
|
obbject.extra = {}
|
|
obbject.show.side_effect = Exception("no chart")
|
|
handle_obbject_display(obbject, chart=True)
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_handle_obbject_display_sqlite_results_materialized(
|
|
mock_session, sample_df_helper
|
|
):
|
|
"""SQLiteTable results are eagerly materialized to a DataFrame before downstream use."""
|
|
from openbb_cli.controllers.utils import SQLiteTable, handle_obbject_display
|
|
|
|
obbject = MagicMock()
|
|
obbject.extra = {"command": "/foo"}
|
|
obbject.chart = None
|
|
sqlite_tbl = MagicMock(spec=SQLiteTable)
|
|
sqlite_tbl.to_dataframe.return_value = sample_df_helper
|
|
obbject.results = sqlite_tbl
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
with patch(
|
|
"openbb_cli.controllers.utils.extract_dataframe", return_value=sample_df_helper
|
|
):
|
|
handle_obbject_display(obbject)
|
|
sqlite_tbl.to_dataframe.assert_called_once()
|
|
|
|
|
|
def test_handle_obbject_display_chart_no_chart_calls_to_chart(mock_session):
|
|
"""When ``obbject.chart`` is None and chart=True, ``charting.to_chart`` is invoked."""
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
obbject = MagicMock()
|
|
obbject.chart = None
|
|
obbject.results = MagicMock()
|
|
obbject.extra = {}
|
|
handle_obbject_display(obbject, chart=True)
|
|
obbject.charting.to_chart.assert_called_once()
|
|
|
|
|
|
def test_handle_obbject_display_export_with_data(
|
|
mock_session, sample_df_helper, tmp_path
|
|
):
|
|
"""``export=...`` and a non-empty DataFrame call ``export_data`` with the assembled func_name."""
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
obbject = MagicMock()
|
|
obbject.chart = None
|
|
obbject.results = sample_df_helper
|
|
obbject.extra = {"command": "/equity/quote --symbol AAPL"}
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
with (
|
|
patch(
|
|
"openbb_cli.controllers.utils.extract_dataframe",
|
|
return_value=sample_df_helper,
|
|
),
|
|
patch("openbb_cli.controllers.utils.export_data") as export_data,
|
|
):
|
|
handle_obbject_display(obbject, export="csv")
|
|
export_data.assert_called_once()
|
|
func_name = export_data.call_args[1]["func_name"]
|
|
assert "equity" in func_name and "quote" in func_name
|
|
assert "/" not in func_name
|
|
assert " " not in func_name
|
|
|
|
|
|
def test_handle_obbject_display_export_with_empty_data_warns(mock_session):
|
|
"""``export=...`` with an empty DataFrame prints a 'No data to export' warning."""
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
obbject = MagicMock()
|
|
obbject.chart = None
|
|
obbject.results = None
|
|
obbject.extra = {"command": "/x"}
|
|
import pandas as pd
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
with patch(
|
|
"openbb_cli.controllers.utils.extract_dataframe",
|
|
return_value=pd.DataFrame(),
|
|
):
|
|
handle_obbject_display(obbject, export="csv")
|
|
calls = [str(c) for c in mock_session.console.print.call_args_list]
|
|
assert any("No data to export" in c for c in calls)
|
|
|
|
|
|
def test_handle_obbject_display_export_with_sheet_name_list(
|
|
mock_session, sample_df_helper
|
|
):
|
|
"""``sheet_name`` passed as a list is unwrapped to its first element."""
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
obbject = MagicMock()
|
|
obbject.chart = None
|
|
obbject.results = sample_df_helper
|
|
obbject.extra = {"command": "/foo"}
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
with (
|
|
patch(
|
|
"openbb_cli.controllers.utils.extract_dataframe",
|
|
return_value=sample_df_helper,
|
|
),
|
|
patch("openbb_cli.controllers.utils.export_data") as export_data,
|
|
):
|
|
handle_obbject_display(obbject, export="xlsx", sheet_name=["MySheet"])
|
|
assert export_data.call_args[1]["sheet_name"] == "MySheet"
|
|
|
|
|
|
def test_handle_obbject_display_interactive_uses_charting_table(mock_session):
|
|
"""``USE_INTERACTIVE_DF=True`` and no chart → ``obbject.charting.table()``."""
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
obbject = MagicMock()
|
|
obbject.chart = None
|
|
obbject.results = MagicMock()
|
|
obbject.extra = {}
|
|
mock_session.settings.USE_INTERACTIVE_DF = True
|
|
handle_obbject_display(obbject)
|
|
obbject.charting.table.assert_called_once()
|
|
|
|
|
|
def test_handle_obbject_display_falls_back_to_dataframe_without_charting(mock_session):
|
|
"""When ``openbb-charting`` isn't installed, ``obbject.charting`` raises
|
|
``AttributeError`` from pydantic. The interactive path catches that and
|
|
falls back to the plain DataFrame display so spec-mode REPL ``results
|
|
-i N`` still surfaces rows instead of crashing on the missing accessor.
|
|
|
|
Uses a real ``OBBject`` (MagicMock would auto-create ``charting`` and
|
|
defeat the test). Isolates ``OBBject.accessors`` — it's a class-level
|
|
set that other tests may have stamped ``"charting"`` into; we strip
|
|
it for the duration of this test and restore on exit so the
|
|
AttributeError actually fires.
|
|
"""
|
|
from openbb_core.app.model.obbject import OBBject
|
|
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
had_charting = "charting" in OBBject.accessors
|
|
OBBject.accessors.discard("charting")
|
|
# Pydantic caches descriptor lookups on the class — purge any
|
|
# ``charting`` descriptor a prior test might have installed so
|
|
# attribute access really raises AttributeError.
|
|
cached_descriptor = OBBject.__dict__.get("charting")
|
|
if cached_descriptor is not None:
|
|
delattr(OBBject, "charting")
|
|
try:
|
|
obbject = OBBject(results=[{"x": 1}], extra={"command": "/foo"})
|
|
mock_session.settings.USE_INTERACTIVE_DF = True
|
|
with patch(
|
|
"openbb_cli.controllers.utils.extract_dataframe", return_value="DF"
|
|
) as ed:
|
|
handle_obbject_display(obbject)
|
|
ed.assert_called_once_with(obbject)
|
|
mock_session.output_adapter.display.assert_called_once()
|
|
finally:
|
|
if had_charting:
|
|
OBBject.accessors.add("charting")
|
|
if cached_descriptor is not None:
|
|
setattr(OBBject, "charting", cached_descriptor)
|
|
|
|
|
|
@pytest.fixture
|
|
def sample_df_helper():
|
|
"""Reusable small DataFrame for utils tests."""
|
|
import pandas as pd
|
|
|
|
return pd.DataFrame({"x": [1, 2], "y": [3, 4]})
|
|
|
|
|
|
def test_get_user_data_directory_returns_path_from_preferences(mock_session, tmp_path):
|
|
"""``get_user_data_directory`` reads ``session.user.preferences.data_directory``."""
|
|
from openbb_cli.controllers.utils import get_user_data_directory
|
|
|
|
mock_session.user.preferences.data_directory = str(tmp_path)
|
|
result = get_user_data_directory()
|
|
assert result == Path(str(tmp_path))
|
|
|
|
|
|
def test_get_data_files_for_completion_lists_supported_extensions(
|
|
mock_session, tmp_path
|
|
):
|
|
"""Walks the user data dir and returns supported file types as relative paths."""
|
|
from openbb_cli.controllers.utils import get_data_files_for_completion
|
|
|
|
mock_session.user.preferences.data_directory = str(tmp_path)
|
|
(tmp_path / "a.csv").write_text("col\n1")
|
|
(tmp_path / "nested").mkdir()
|
|
(tmp_path / "nested" / "b.json").write_text("{}")
|
|
(tmp_path / "ignored.txt").write_text("ignored")
|
|
files = get_data_files_for_completion()
|
|
assert "a.csv" in files
|
|
assert any("b.json" in f for f in files)
|
|
assert all(not f.endswith(".txt") for f in files)
|
|
|
|
|
|
def test_get_data_files_for_completion_returns_empty_when_dir_missing(
|
|
mock_session, tmp_path
|
|
):
|
|
"""Missing user data dir → empty list (no exception)."""
|
|
from openbb_cli.controllers.utils import get_data_files_for_completion
|
|
|
|
mock_session.user.preferences.data_directory = str(tmp_path / "does-not-exist")
|
|
assert get_data_files_for_completion() == []
|
|
|
|
|
|
def test_get_data_files_for_completion_swallows_exceptions(mock_session):
|
|
"""If walking the path raises, the helper swallows and returns ``[]``."""
|
|
from openbb_cli.controllers.utils import get_data_files_for_completion
|
|
|
|
with patch(
|
|
"openbb_cli.controllers.utils.get_user_data_directory",
|
|
side_effect=Exception("boom"),
|
|
):
|
|
assert get_data_files_for_completion() == []
|
|
|
|
|
|
def test_save_to_excel_appends_when_sheet_exists(mock_session, tmp_path):
|
|
"""When the target sheet already exists and the user picks ``a``, data is appended."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import save_to_excel
|
|
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
target = tmp_path / "out.xlsx"
|
|
save_to_excel(df, target, sheet_name="Sheet1")
|
|
with patch("builtins.input", return_value="a"):
|
|
save_to_excel(pd.DataFrame({"a": [3, 4]}), target, sheet_name="Sheet1")
|
|
final = pd.read_excel(target, sheet_name="Sheet1")
|
|
assert len(final) >= 2
|
|
|
|
|
|
def test_save_to_excel_overwrites_when_sheet_exists(mock_session, tmp_path):
|
|
"""``o`` (overwrite) branch replaces the existing sheet."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import save_to_excel
|
|
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
target = tmp_path / "out.xlsx"
|
|
save_to_excel(df, target, sheet_name="Sheet1")
|
|
with patch("builtins.input", return_value="o"):
|
|
save_to_excel(pd.DataFrame({"a": [10]}), target, sheet_name="Sheet1")
|
|
final = pd.read_excel(target, sheet_name="Sheet1")
|
|
assert final["a"].iloc[0] == 10
|
|
|
|
|
|
def test_remove_timezone_from_dataframe_strips_tz_aware_index(mock_session):
|
|
"""tz-aware datetime *index* is converted to date objects (no tzinfo).
|
|
|
|
The function gates column conversion on the index being datetime-like, so
|
|
a tz-aware index is the canonical setup for exercising the strip path.
|
|
"""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import remove_timezone_from_dataframe
|
|
|
|
df = pd.DataFrame(
|
|
{"value": [1, 2]},
|
|
index=pd.to_datetime(["2024-01-01", "2024-01-02"], utc=True),
|
|
)
|
|
cleaned = remove_timezone_from_dataframe(df)
|
|
assert getattr(cleaned.index[0], "tzinfo", None) is None
|
|
|
|
|
|
def test_reset_failure_falls_back_to_print_goodbye(mock_session):
|
|
"""If ``main`` raises during reset, ``print_goodbye`` is invoked as a graceful fallback.
|
|
|
|
``reset`` deletes ``openbb_cli.*`` from ``sys.modules`` as part of its
|
|
contract, which would break every subsequent test that holds references
|
|
to the original module classes. Snapshot/restore ``sys.modules`` (and
|
|
re-pin the classes the test file imported at top level) so downstream
|
|
tests see the same identity they started with.
|
|
"""
|
|
import sys
|
|
from types import ModuleType
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
purged_keys = [k for k in sys.modules if k.startswith("openbb_cli")]
|
|
snapshot = {k: sys.modules[k] for k in purged_keys}
|
|
|
|
from openbb_cli.controllers.utils import reset
|
|
|
|
stub = ModuleType("openbb_cli.controllers.cli_controller")
|
|
stub.main = MagicMock(side_effect=RuntimeError("boom"))
|
|
try:
|
|
with patch("openbb_cli.controllers.utils.print_goodbye") as goodbye:
|
|
sys.modules["openbb_cli.controllers.cli_controller"] = stub
|
|
reset(queue=["x"])
|
|
goodbye.assert_called_once()
|
|
mock_session.console.print.assert_called()
|
|
finally:
|
|
for k, mod in snapshot.items():
|
|
sys.modules[k] = mod
|
|
|
|
|
|
def test_extract_dataframe_from_obbject_with_list_results(mock_session):
|
|
"""OBBject with list results → DataFrame with one row per item."""
|
|
from unittest.mock import MagicMock
|
|
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import extract_dataframe
|
|
|
|
obbj = MagicMock()
|
|
obbj.model_dump.return_value = {"results": [{"a": 1}, {"a": 2}]}
|
|
df = extract_dataframe(obbj)
|
|
assert isinstance(df, pd.DataFrame)
|
|
assert df["a"].tolist() == [1, 2]
|
|
|
|
|
|
def test_extract_dataframe_from_obbject_with_none_results_returns_empty(mock_session):
|
|
from unittest.mock import MagicMock
|
|
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import extract_dataframe
|
|
|
|
obbj = MagicMock()
|
|
obbj.model_dump.return_value = {"results": None}
|
|
df = extract_dataframe(obbj)
|
|
assert isinstance(df, pd.DataFrame)
|
|
assert df.empty
|
|
|
|
|
|
def test_extract_dataframe_with_dict_results(mock_session):
|
|
from unittest.mock import MagicMock
|
|
|
|
from openbb_cli.controllers.utils import extract_dataframe
|
|
|
|
obbj = MagicMock()
|
|
obbj.model_dump.return_value = {"results": {"x": 10, "y": 20}}
|
|
df = extract_dataframe(obbj)
|
|
assert df["x"].iloc[0] == 10
|
|
|
|
|
|
def test_extract_dataframe_with_scalar_results(mock_session):
|
|
"""Scalar results wrap into ``DataFrame({'value': [scalar]})``."""
|
|
from unittest.mock import MagicMock
|
|
|
|
from openbb_cli.controllers.utils import extract_dataframe
|
|
|
|
obbj = MagicMock()
|
|
obbj.model_dump.return_value = {"results": 42}
|
|
df = extract_dataframe(obbj)
|
|
assert df["value"].iloc[0] == 42
|
|
|
|
|
|
def test_extract_dataframe_with_existing_dataframe(mock_session):
|
|
"""OBBject with an already-built DataFrame is returned as-is."""
|
|
from unittest.mock import MagicMock
|
|
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import extract_dataframe
|
|
|
|
sentinel = pd.DataFrame({"col": [1, 2]})
|
|
obbj = MagicMock()
|
|
obbj.model_dump.return_value = {"results": sentinel}
|
|
df = extract_dataframe(obbj)
|
|
assert df is sentinel
|
|
|
|
|
|
def test_extract_dataframe_passthrough_non_obbject_data(mock_session):
|
|
"""Non-OBBject data (no ``model_dump``) is treated as the results directly."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import extract_dataframe
|
|
|
|
df_in = pd.DataFrame({"col": [1]})
|
|
result = extract_dataframe(df_in)
|
|
assert result is df_in
|
|
|
|
|
|
def test_remove_timezone_from_dataframe_passthrough_for_naive(mock_session):
|
|
"""tz-naive columns survive the round-trip unchanged."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import remove_timezone_from_dataframe
|
|
|
|
df = pd.DataFrame({"ts": pd.to_datetime(["2024-01-01"])})
|
|
cleaned = remove_timezone_from_dataframe(df)
|
|
assert cleaned.equals(df) or cleaned["ts"].iloc[0] == df["ts"].iloc[0]
|
|
|
|
|
|
def test_export_data_writes_csv(mock_session, tmp_path):
|
|
"""``export_type='csv'`` writes a CSV file at the composed path."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
mock_session.settings.TEST_MODE = False
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
export_data(
|
|
export_type="csv",
|
|
dir_path=str(tmp_path / "stocks" / "fundamentals"),
|
|
func_name="balance",
|
|
df=df,
|
|
)
|
|
csv_files = list(tmp_path.glob("*.csv"))
|
|
assert csv_files, "expected at least one CSV in the export directory"
|
|
|
|
|
|
def test_export_data_writes_json(mock_session, tmp_path):
|
|
"""``export_type='json'`` writes a JSON file."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
export_data(
|
|
export_type="json",
|
|
dir_path=str(tmp_path / "stocks" / "fundamentals"),
|
|
func_name="balance",
|
|
df=df,
|
|
)
|
|
assert list(tmp_path.glob("*.json")), "expected JSON output"
|
|
|
|
|
|
def test_export_data_no_export_type_is_noop(mock_session, tmp_path):
|
|
"""Empty ``export_type`` short-circuits."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
df = pd.DataFrame({"a": [1]})
|
|
export_data(
|
|
export_type="",
|
|
dir_path=str(tmp_path),
|
|
func_name="cmd",
|
|
df=df,
|
|
)
|
|
assert not list(tmp_path.iterdir())
|
|
|
|
|
|
def test_export_data_strips_rich_color_tags(mock_session, tmp_path):
|
|
"""Rich color tags inside DataFrame values are stripped before writing."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
df = pd.DataFrame({"col": ["[green]ok[/green]", "[red]bad[/red]"]})
|
|
export_data(
|
|
export_type="csv",
|
|
dir_path=str(tmp_path / "x" / "y"),
|
|
func_name="cmd",
|
|
df=df,
|
|
)
|
|
csv = next(tmp_path.glob("*.csv"))
|
|
text = csv.read_text()
|
|
assert "ok" in text and "bad" in text
|
|
assert "[green]" not in text
|
|
assert "[red]" not in text
|
|
|
|
|
|
def test_export_data_explicit_filename_with_extension(mock_session, tmp_path):
|
|
"""``export_type='out.csv'`` exports under exactly that filename."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
df = pd.DataFrame({"a": [1]})
|
|
export_data(
|
|
export_type="out.csv",
|
|
dir_path=str(tmp_path / "x"),
|
|
func_name="cmd",
|
|
df=df,
|
|
)
|
|
assert (tmp_path / "out.csv").exists()
|
|
|
|
|
|
def test_export_data_writes_xlsx(mock_session, tmp_path):
|
|
"""``export_type='xlsx'`` writes an Excel workbook (default sheet path)."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
export_data(
|
|
export_type="xlsx",
|
|
dir_path=str(tmp_path / "stocks"),
|
|
func_name="balance",
|
|
df=df,
|
|
)
|
|
assert list(tmp_path.glob("*.xlsx"))
|
|
|
|
|
|
def test_export_data_writes_xlsx_with_sheet_name(mock_session, tmp_path):
|
|
"""``sheet_name`` routes through ``save_to_excel`` (sheet-aware writer)."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
df = pd.DataFrame({"a": [1]})
|
|
with patch("openbb_cli.controllers.utils.save_to_excel") as save_to_excel:
|
|
export_data(
|
|
export_type="xlsx",
|
|
dir_path=str(tmp_path / "x"),
|
|
func_name="cmd",
|
|
df=df,
|
|
sheet_name="Custom",
|
|
)
|
|
save_to_excel.assert_called_once()
|
|
|
|
|
|
def test_export_data_image_without_figure_warns(mock_session, tmp_path):
|
|
"""``export_type='out.png'`` without a figure prints 'No plot to export.'"""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
df = pd.DataFrame({"a": [1]})
|
|
export_data(
|
|
export_type="out.png",
|
|
dir_path=str(tmp_path / "x"),
|
|
func_name="cmd",
|
|
df=df,
|
|
figure=None,
|
|
)
|
|
calls = [str(c) for c in mock_session.console.print.call_args_list]
|
|
assert any("No plot to export" in c for c in calls)
|
|
|
|
|
|
def test_export_data_image_with_figure_calls_show(mock_session, tmp_path):
|
|
"""``export_type='out.jpg'`` with a figure calls ``figure.show(export_image=path)``."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
df = pd.DataFrame({"a": [1]})
|
|
fig = MagicMock()
|
|
export_data(
|
|
export_type="out.jpg",
|
|
dir_path=str(tmp_path / "x"),
|
|
func_name="cmd",
|
|
df=df,
|
|
figure=fig,
|
|
)
|
|
fig.show.assert_called_once()
|
|
|
|
|
|
def test_export_data_sqlite_creates_new_table(mock_session, tmp_path):
|
|
"""SQLite export to a fresh DB writes the data table without prompting."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
export_data(
|
|
export_type="out.db",
|
|
dir_path=str(tmp_path / "x"),
|
|
func_name="cmd",
|
|
df=df,
|
|
)
|
|
db_files = list(tmp_path.glob("*.db"))
|
|
assert db_files
|
|
|
|
|
|
def test_export_data_unknown_extension_warns(mock_session, tmp_path):
|
|
"""Unknown extension (``.parquet``) hits the catch-all 'Wrong export file specified.'"""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.settings.FILE_OVERWRITE = True
|
|
df = pd.DataFrame({"a": [1]})
|
|
export_data(
|
|
export_type="out.parquet",
|
|
dir_path=str(tmp_path / "x"),
|
|
func_name="cmd",
|
|
df=df,
|
|
)
|
|
calls = [str(c) for c in mock_session.console.print.call_args_list]
|
|
assert any("Wrong export file" in c for c in calls)
|
|
|
|
|
|
def test_print_rich_table_returns_when_export_true(mock_session):
|
|
"""``export=True`` short-circuits without printing."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
print_rich_table(df, export=True)
|
|
mock_session.console.print.assert_not_called()
|
|
|
|
|
|
def test_print_rich_table_basic_dataframe_renders(mock_session):
|
|
"""Basic non-interactive path prints the table via session.console."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
mock_session.backend = None
|
|
df = pd.DataFrame({"a": [1, 2], "b": ["x", "y"]})
|
|
print_rich_table(df, title="Test Table")
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_print_rich_table_validates_header_length(mock_session):
|
|
"""Header list whose length mismatches DataFrame columns raises ValueError."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = True
|
|
mock_session.backend = MagicMock()
|
|
df = pd.DataFrame({"a": [1], "b": [2]})
|
|
with pytest.raises(ValueError, match="Length of headers"):
|
|
print_rich_table(df, headers=["only_one"])
|
|
|
|
|
|
def test_print_rich_table_interactive_send_table(mock_session):
|
|
"""Interactive mode + backend → ``backend.send_table`` is invoked."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = True
|
|
mock_session.backend = MagicMock()
|
|
mock_session.user.preferences.table_style = "dark"
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
print_rich_table(df, title="t", show_index=True, index_name="Idx")
|
|
mock_session.backend.send_table.assert_called_once()
|
|
|
|
|
|
def test_print_rich_table_interactive_failure_falls_through(mock_session):
|
|
"""If ``backend.send_table`` raises, the rich-table path runs as fallback."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = True
|
|
mock_session.backend = MagicMock()
|
|
mock_session.backend.send_table.side_effect = Exception("backend down")
|
|
mock_session.user.preferences.table_style = "dark"
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
print_rich_table(df)
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_print_rich_table_floatfmt_list_length_mismatch(mock_session):
|
|
"""``floatfmt`` list of wrong length raises ValueError."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
mock_session.backend = None
|
|
df = pd.DataFrame({"a": [1.0], "b": [2.0]})
|
|
with pytest.raises(ValueError, match="floatfmt"):
|
|
print_rich_table(df, floatfmt=["only_one"])
|
|
|
|
|
|
def test_print_rich_table_use_tabulate_false_uses_to_string(mock_session):
|
|
"""``use_tabulate_df=False`` prints via ``df.to_string``."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
mock_session.backend = None
|
|
df = pd.DataFrame({"a": [1, 2]})
|
|
print_rich_table(df, use_tabulate_df=False)
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_print_rich_table_automatic_coloring_with_columns(mock_session):
|
|
"""``automatic_coloring`` + ``columns_to_auto_color`` colors only those columns."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
mock_session.backend = None
|
|
df = pd.DataFrame({"a": [1.0, -2.0], "b": [3.0, 4.0]})
|
|
print_rich_table(df, automatic_coloring=True, columns_to_auto_color=["a"])
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_print_rich_table_automatic_coloring_blanket_apply(mock_session):
|
|
"""``automatic_coloring`` without column/row filters maps the entire DataFrame."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
mock_session.backend = None
|
|
df = pd.DataFrame({"a": [1.0, -2.0], "b": [3.0, 4.0]})
|
|
print_rich_table(df, automatic_coloring=True)
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_parse_and_split_input_with_trailing_slash():
|
|
"""An input ending with ``/`` triggers the empty-trailing-segment branch."""
|
|
out = parse_and_split_input("foo/", custom_filters=[])
|
|
assert out == ["foo"]
|
|
|
|
|
|
def test_print_rich_table_columns_keep_types(mock_session):
|
|
"""``columns_keep_types`` skips coercion for listed columns."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
mock_session.backend = None
|
|
df = pd.DataFrame({"keep": ["mixed", "data"], "convert": ["1", "2"]})
|
|
print_rich_table(df, columns_keep_types=["keep"])
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_print_rich_table_headers_as_pandas_index(mock_session):
|
|
"""``headers`` passed as ``pd.Index`` exercises ``_get_headers`` index branch."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = True
|
|
mock_session.backend = MagicMock()
|
|
df = pd.DataFrame({"a": [1], "b": [2]})
|
|
print_rich_table(df, headers=pd.Index(["one", "two"]))
|
|
mock_session.backend.send_table.assert_called_once()
|
|
|
|
|
|
def test_print_rich_table_interactive_with_show_index_and_named_index(mock_session):
|
|
"""Interactive path with ``show_index=True`` and named index."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = True
|
|
mock_session.backend = MagicMock()
|
|
df = pd.DataFrame({"a": [1, 2]}, index=pd.Index(["r1", "r2"]))
|
|
print_rich_table(df, show_index=True, index_name="Idx")
|
|
mock_session.backend.send_table.assert_called_once()
|
|
|
|
|
|
def test_print_rich_table_interactive_renames_blank_columns(mock_session):
|
|
"""Interactive path renames empty-string column names to ``" "``."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = True
|
|
mock_session.backend = MagicMock()
|
|
df = pd.DataFrame({"a": [1], "": [2]})
|
|
print_rich_table(df)
|
|
sent = mock_session.backend.send_table.call_args[1]["df_table"]
|
|
assert " " in sent.columns
|
|
|
|
|
|
def test_print_rich_table_rows_to_auto_color(mock_session):
|
|
"""``rows_to_auto_color`` colors specified rows."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
mock_session.backend = None
|
|
df = pd.DataFrame(
|
|
{"a": ["1.0", "-2.0"], "b": ["3.0", "4.0"]},
|
|
index=["r1", "r2"],
|
|
dtype=object,
|
|
)
|
|
print_rich_table(
|
|
df,
|
|
automatic_coloring=True,
|
|
rows_to_auto_color=["r1"],
|
|
columns_keep_types=["a", "b"],
|
|
)
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_print_rich_table_tabulate_with_show_index_and_headers(mock_session):
|
|
"""Tabulate path with ``show_index`` and custom ``headers``."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import print_rich_table
|
|
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
mock_session.backend = None
|
|
df = pd.DataFrame({"a": [1], "b": [2]}, index=["r1"])
|
|
print_rich_table(df, show_index=True, index_name="Idx", headers=["A", "B"])
|
|
mock_session.console.print.assert_called()
|
|
|
|
|
|
def test_remove_timezone_from_dataframe_strips_tz_columns(mock_session):
|
|
"""A tz-aware datetime column is stripped to date-only."""
|
|
import pandas as pd
|
|
|
|
from openbb_cli.controllers.utils import remove_timezone_from_dataframe
|
|
|
|
df = pd.DataFrame(
|
|
{
|
|
"dt": pd.to_datetime(["2024-01-01", "2024-01-02"]).tz_localize("UTC"),
|
|
}
|
|
)
|
|
df.index = pd.to_datetime(["2024-01-01", "2024-01-02"]).tz_localize("UTC")
|
|
out = remove_timezone_from_dataframe(df)
|
|
assert out["dt"].iloc[0] == pd.Timestamp("2024-01-01").date()
|
|
|
|
|
|
def test_export_data_collapses_openbb_cli_filename_marker(
|
|
mock_session, tmp_path, sample_df_helper
|
|
):
|
|
"""A filename containing ``.OpenBB_openbb_cli`` is rewritten to ``OpenBBCLI``."""
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.user.preferences.overwrite_export = True
|
|
fake_dir = tmp_path / ".OpenBB" / "openbb_cli"
|
|
fake_dir.mkdir(parents=True)
|
|
export_data(
|
|
export_type="csv",
|
|
dir_path=str(fake_dir),
|
|
func_name="myfunc",
|
|
df=sample_df_helper,
|
|
)
|
|
files = list(tmp_path.glob("*.csv"))
|
|
assert any("OpenBBCLI" in f.name for f in files)
|
|
|
|
|
|
def test_export_data_existing_file_collision_increments(
|
|
mock_session, tmp_path, sample_df_helper
|
|
):
|
|
"""Existing file + user declines overwrite → bumps the filename suffix."""
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
(tmp_path / "preexisting.csv").write_text("col\n1")
|
|
with patch(
|
|
"openbb_cli.controllers.utils.ask_file_overwrite",
|
|
return_value=(True, False),
|
|
):
|
|
export_data(
|
|
export_type="csv",
|
|
dir_path=str(tmp_path),
|
|
func_name="myfunc",
|
|
df=sample_df_helper,
|
|
)
|
|
csvs = list(tmp_path.glob("*.csv"))
|
|
assert len(csvs) >= 2
|
|
|
|
|
|
def _seed_sqlite_table(target, df, name="data"):
|
|
"""Pre-populate a SQLite db with ``df`` rows under ``name`` using sqlite3 directly.
|
|
|
|
Avoids pandas' SQLAlchemy URI requirement.
|
|
"""
|
|
import sqlite3
|
|
|
|
conn = sqlite3.connect(target)
|
|
try:
|
|
df.to_sql(name, conn, if_exists="replace", index=False)
|
|
finally:
|
|
conn.close()
|
|
|
|
|
|
def test_export_data_sqlite_existing_table_overwrite(
|
|
mock_session, tmp_path, sample_df_helper
|
|
):
|
|
"""SQLite export with existing table + 'o' choice → ``if_exists='replace'``."""
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.user.preferences.overwrite_export = True
|
|
target = tmp_path / "out.db"
|
|
_seed_sqlite_table(target, sample_df_helper)
|
|
with patch("builtins.input", return_value="o"):
|
|
export_data(
|
|
export_type="out.db",
|
|
dir_path=str(tmp_path),
|
|
func_name="myfunc",
|
|
df=sample_df_helper,
|
|
)
|
|
import sqlite3
|
|
|
|
conn = sqlite3.connect(target)
|
|
rows = conn.execute("SELECT * FROM data").fetchall()
|
|
conn.close()
|
|
assert len(rows) == len(sample_df_helper)
|
|
|
|
|
|
def test_export_data_sqlite_existing_table_append(
|
|
mock_session, tmp_path, sample_df_helper
|
|
):
|
|
"""SQLite with 'a' choice appends to existing table."""
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.user.preferences.overwrite_export = True
|
|
target = tmp_path / "out.db"
|
|
_seed_sqlite_table(target, sample_df_helper)
|
|
with patch("builtins.input", return_value="a"):
|
|
export_data(
|
|
export_type="out.db",
|
|
dir_path=str(tmp_path),
|
|
func_name="myfunc",
|
|
df=sample_df_helper,
|
|
)
|
|
import sqlite3
|
|
|
|
conn = sqlite3.connect(target)
|
|
count = conn.execute("SELECT COUNT(*) FROM data").fetchone()[0]
|
|
conn.close()
|
|
assert count == 2 * len(sample_df_helper)
|
|
|
|
|
|
def test_export_data_sqlite_existing_table_new_name(
|
|
mock_session, tmp_path, sample_df_helper
|
|
):
|
|
"""SQLite with 'n' creates a new uniquely-named table."""
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.user.preferences.overwrite_export = True
|
|
target = tmp_path / "out.db"
|
|
_seed_sqlite_table(target, sample_df_helper)
|
|
with patch("builtins.input", return_value="n"):
|
|
export_data(
|
|
export_type="out.db",
|
|
dir_path=str(tmp_path),
|
|
func_name="myfunc",
|
|
df=sample_df_helper,
|
|
)
|
|
import sqlite3
|
|
|
|
conn = sqlite3.connect(target)
|
|
names = {
|
|
row[0]
|
|
for row in conn.execute("SELECT name FROM sqlite_master WHERE type='table'")
|
|
}
|
|
conn.close()
|
|
assert "data_1" in names
|
|
|
|
|
|
def test_export_data_sqlite_invalid_choice_skips(
|
|
mock_session, tmp_path, sample_df_helper
|
|
):
|
|
"""SQLite with any other input skips the export."""
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.user.preferences.overwrite_export = True
|
|
target = tmp_path / "out.db"
|
|
_seed_sqlite_table(target, sample_df_helper)
|
|
with patch("builtins.input", return_value="garbage"):
|
|
export_data(
|
|
export_type="out.db",
|
|
dir_path=str(tmp_path),
|
|
func_name="myfunc",
|
|
df=sample_df_helper,
|
|
)
|
|
msgs = [str(c) for c in mock_session.console.print.call_args_list]
|
|
assert any("Invalid choice" in m for m in msgs)
|
|
|
|
|
|
def test_handle_obbject_display_chart_with_export_extracts_dataframe(mock_session):
|
|
"""``chart=True`` AND ``export=...`` triggers chart-fig + DataFrame extract."""
|
|
from openbb_cli.controllers.utils import handle_obbject_display
|
|
|
|
obbject = MagicMock()
|
|
obbject.chart = MagicMock()
|
|
obbject.results = MagicMock()
|
|
obbject.extra = {"command": "/x"}
|
|
mock_session.settings.USE_INTERACTIVE_DF = False
|
|
with (
|
|
patch(
|
|
"openbb_cli.controllers.utils.extract_dataframe",
|
|
) as extract,
|
|
patch("openbb_cli.controllers.utils.export_data") as export_data,
|
|
):
|
|
import pandas as pd
|
|
|
|
extract.return_value = pd.DataFrame({"x": [1]})
|
|
handle_obbject_display(obbject, chart=True, export="png")
|
|
obbject.show.assert_called_once()
|
|
extract.assert_called()
|
|
export_data.assert_called_once()
|
|
|
|
|
|
@pytest.fixture
|
|
def sqlite_db(tmp_path):
|
|
"""Pre-populated SQLite database with a small table."""
|
|
import sqlite3
|
|
|
|
import pandas as pd
|
|
|
|
db = tmp_path / "store.db"
|
|
conn = sqlite3.connect(db)
|
|
pd.DataFrame({"a": [1, 2, 3], "b": ["x", "y", "z"]}).to_sql(
|
|
"rows", conn, if_exists="replace", index=False
|
|
)
|
|
conn.close()
|
|
return db
|
|
|
|
|
|
def test_sqlite_table_init_stores_args(sqlite_db):
|
|
"""``SQLiteTable.__init__`` stores the path/name/count and clears cache."""
|
|
from openbb_cli.controllers.utils import SQLiteTable
|
|
|
|
tbl = SQLiteTable(db_path=str(sqlite_db), table_name="rows", row_count=3)
|
|
assert tbl.db_path == str(sqlite_db)
|
|
assert tbl.table_name == "rows"
|
|
assert tbl.row_count == 3
|
|
assert tbl._cached_df is None
|
|
|
|
|
|
def test_sqlite_table_quoted_name_escapes_quotes(sqlite_db):
|
|
"""``_quoted_name`` doubles internal quotes and wraps in double-quotes."""
|
|
from openbb_cli.controllers.utils import SQLiteTable
|
|
|
|
tbl = SQLiteTable(db_path=str(sqlite_db), table_name='weird"name', row_count=0)
|
|
assert tbl._quoted_name == '"weird""name"'
|
|
|
|
|
|
def test_sqlite_table_to_dataframe_caches(sqlite_db):
|
|
"""``to_dataframe`` loads from disk on first call and caches afterward."""
|
|
from openbb_cli.controllers.utils import SQLiteTable
|
|
|
|
tbl = SQLiteTable(db_path=str(sqlite_db), table_name="rows", row_count=3)
|
|
first = tbl.to_dataframe()
|
|
assert len(first) == 3
|
|
assert tbl._cached_df is not None
|
|
second = tbl.to_dataframe()
|
|
assert second is tbl._cached_df
|
|
|
|
|
|
def test_sqlite_table_to_dataframe_no_cache(sqlite_db):
|
|
"""``use_cache=False`` skips caching entirely."""
|
|
from openbb_cli.controllers.utils import SQLiteTable
|
|
|
|
tbl = SQLiteTable(db_path=str(sqlite_db), table_name="rows", row_count=3)
|
|
out = tbl.to_dataframe(use_cache=False)
|
|
assert len(out) == 3
|
|
assert tbl._cached_df is None
|
|
|
|
|
|
def test_sqlite_table_get_schema_returns_pragma_rows(sqlite_db):
|
|
"""``get_schema`` returns the PRAGMA table_info rows."""
|
|
from openbb_cli.controllers.utils import SQLiteTable
|
|
|
|
tbl = SQLiteTable(db_path=str(sqlite_db), table_name="rows", row_count=3)
|
|
schema = tbl.get_schema()
|
|
column_names = {row[1] for row in schema}
|
|
assert column_names == {"a", "b"}
|
|
|
|
|
|
def test_sqlite_table_query_with_where_and_limit(sqlite_db):
|
|
"""``query`` builds SQL with optional WHERE + LIMIT clauses."""
|
|
from openbb_cli.controllers.utils import SQLiteTable
|
|
|
|
tbl = SQLiteTable(db_path=str(sqlite_db), table_name="rows", row_count=3)
|
|
out = tbl.query(where="a > 1", limit=1)
|
|
assert len(out) == 1
|
|
assert int(out["a"].iloc[0]) > 1
|
|
|
|
|
|
def test_sqlite_table_query_no_filters(sqlite_db):
|
|
"""``query`` with no filters returns all rows."""
|
|
from openbb_cli.controllers.utils import SQLiteTable
|
|
|
|
tbl = SQLiteTable(db_path=str(sqlite_db), table_name="rows", row_count=3)
|
|
assert len(tbl.query()) == 3
|
|
|
|
|
|
def test_extract_dataframe_with_sqlite_table_lazy_loads(sqlite_db):
|
|
"""``extract_dataframe`` materializes a ``SQLiteTable`` via ``to_dataframe``."""
|
|
from openbb_cli.controllers.utils import SQLiteTable, extract_dataframe
|
|
|
|
tbl = SQLiteTable(db_path=str(sqlite_db), table_name="rows", row_count=3)
|
|
obbject = MagicMock()
|
|
obbject.model_dump.return_value = {"results": tbl}
|
|
out = extract_dataframe(obbject)
|
|
assert len(out) == 3
|
|
assert set(out.columns) == {"a", "b"}
|
|
|
|
|
|
def test_parse_and_split_input_with_custom_filter():
|
|
"""A non-None entry in ``custom_filters`` is appended to the regex."""
|
|
out = parse_and_split_input(
|
|
"load AAPL/help", custom_filters=[r"\bload\s+\w+", None]
|
|
)
|
|
assert any("load" in seg for seg in out)
|
|
|
|
|
|
def test_export_data_sqlite_new_name_collision_loops(
|
|
mock_session, tmp_path, sample_df_helper
|
|
):
|
|
"""When 'n' is chosen and ``data_1`` already exists, the loop bumps to ``data_2``."""
|
|
from openbb_cli.controllers.utils import export_data
|
|
|
|
mock_session.user.preferences.export_directory = str(tmp_path)
|
|
mock_session.user.preferences.overwrite_export = True
|
|
target = tmp_path / "out.db"
|
|
import sqlite3
|
|
|
|
conn = sqlite3.connect(target)
|
|
sample_df_helper.to_sql("data", conn, if_exists="replace", index=False)
|
|
sample_df_helper.to_sql("data_1", conn, if_exists="replace", index=False)
|
|
conn.close()
|
|
with patch("builtins.input", return_value="n"):
|
|
export_data(
|
|
export_type="out.db",
|
|
dir_path=str(tmp_path),
|
|
func_name="myfunc",
|
|
df=sample_df_helper,
|
|
)
|
|
conn = sqlite3.connect(target)
|
|
names = {
|
|
row[0]
|
|
for row in conn.execute("SELECT name FROM sqlite_master WHERE type='table'")
|
|
}
|
|
conn.close()
|
|
assert "data_2" in names
|