Repository navigation
docs(financials): say why get_quarterly_financials() is None for a 6-K filer (GH #1824) - #1870
Merged
Merged
Conversation
…K filer (GH #1824) TSMC files its quarterly results on Form 6-K as an HTML press release with no XBRL, so get_quarterly_financials() returns None, which is the 6.0 contract. Neither guide said so, and the 6-K guide told readers to "parse the press release exhibits directly" without naming the reader that does it. financial-data.md gains a foreign-private-issuer section with a runnable example on TSMC's 3Q26 release (0001046179-26-000726): net income 763,064 vs 452,302, NT$ million as printed. The 6-K guide and the method docstring point to EarningsRelease.from_filing(). A regression test runs the example from a cassette recorded from live SEC. The HTML fallback itself stays in #1825 for 6.1. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this changes
Company("TSM").get_quarterly_financials()returnsNone, because TSMC's quarterly results arrive on Form 6-K as an HTML press release with no XBRL. That's the 6.0 contract, but neither guide said so, and the 6-K guide told readers to "parse the press release exhibits directly" without naming the reader that does it.financial-data.mdnow has a section on foreign private issuers with a runnableEarningsRelease.from_filing()example, and the 6-K guide and the method docstring point to it. No behaviour change.This covers the "clarify" half of #1824. The HTML fallback itself stays in #1825 for 6.1. Refs #1824
Verification
a3q26e_withguidancexfinal.htm, unit "NT$ million": 3Q26 net income 763,064 and 3Q25 452,302, read from the exhibit.tests/issues/regression/test_issue_1824_6k_quarterly_docs.py(docstring links get_quarterly_financials() returns None for TSM — clarify or improve the 6-K fallback #1824) runs the documented example as written and checks that the guide still shows it. It passes under-p tests._offline_harness.hatch run test-fast: 50,547 passed, 5 failed. All 5 are intest_issue_282_xbrl_api_regression.py. They fail the same way on the unrelated #1869 branch and pass on their own, so they depend on test order on main.check-regression-provenanceandcheck-cassettespass.6.0
No 6.0 change. This documents the existing
Nonefrom docs/upgrade/6.0.md.AI assistance
🤖 Generated with Claude Code