Repository navigation
feat(schedule13)!: figures a filing does not report are None, not 0 (edgartools-u6tkw) - #1621
Merged
Merged
Conversation
Every breaking PR since v5.62.0 (17) and every pending removed/changed fragment (19) has a section; nothing was missing. Fixes from reading the whole guide and running all 43 python blocks against main: - The intro said 6.0 is still in development; it now says the page covers every change merged for 6.0. - "Each of these warns in 5.x" was false for two removals that never warned (edgar.core.Result, the names outside edgar.__all__); the note now lists what warned and names the two that did not. - "Still to come": public API enforcement shipped (#1611) and the source tree reorg was deferred to 6.x; both rows are gone. The Schedule 13D/G row stays until edgartools-u6tkw lands. - The five `sed -i ''` rewrites were macOS-only; they are perl -pi -e now, tested on a sample file. - The get_concept() lease example returned None for every company: get_concept takes synonym-group names, not raw tags. It uses get_fact() with a same-period check (Snowflake: 59.8M + 420.0M = 479.8M). - Smaller accuracy fixes: the access modes did not move to edgar.settings, __all__ shipped in 5.47.0, the Apple blank-cell row is fiscal 2023, the Citigroup Item 1 count names its filing, the mda example's comment. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…edgartools-u6tkw) 6.0 flip staged in 5.x by #1379/#1384/#1400. ReportingPerson's six ownership figures hold None for an unreported figure (__post_init__ keeps the fields and unreported_fields in step, so 5.x-style construction with a placeholder 0 still works); total_voting_power/total_dispositive_power are None when either half is; Schedule13D/G total_shares/total_percent use the shared _reported_total rule (None for a counted person leaving the figure out or no reporting-person rows; 0 when every person is excluded). OwnershipComparison.shares_change/percent_change and get_summary() values are None for unreported figures and no longer emit a FutureWarning; reported_shares_change/reported_percent_change and ReportingPerson.reported() stay as non-warning aliases. Tests in test_issue_1379 that asserted the 5.x placeholder 0s and the FutureWarning now assert None and no warning. New regression test pins values from BML Investment Partners' 13D on Aadi Bioscience, 0001373604-24-000118. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ning/edgartools into feat/u6tkw-schedule13-unreported-is-none
…me becomes Not in 6.0 (edgartools-u6tkw) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
dgunning
enabled auto-merge (squash)
October 18, 2026 21:17
Resolve docs/upgrade/6.0.md: keep this branch's Schedule 13D/G section and 'Not in 6.0'; main's 'Still to come' table (from #1620) described this change as pending. 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 is the last staged 6.0 flip. The migration guide promised it under "Still to come", and it warned in 5.x through a
FutureWarningonshares_change,percent_changeandget_summary(). Schedule 13D/G ownership figures a filing does not report are nowNoneinstead of0. A reported0stays0.ReportingPerson's six ownership figuresNonewhen unreported. The fields areOptional, and a new__post_init__keeps them andunreported_fieldsin step, so the 5.x construction style of a placeholder 0 plusunreported_fieldsstill workstotal_voting_power,total_dispositive_powerNonewhen either half is unreportedSchedule13D/13Gtotal_shares,total_percent_reported_totalrule, where there used to be four copies.Nonewhen a counted person leaves the figure out or there are no reporting-person rows. Still0when every person isis_aggregate_exclude_sharesOwnershipComparison.shares_change,percent_change,get_summary()None-safe values. The FutureWarning helpers and_placeholder_totalare removedThe 5.x
None-returning names stay as non-warning aliases:reported(),unreported_fields,reported_shares_changeandreported_percent_change.Consumers checked.
rendering.py,to_context, the direction flags and the MCP reader (edgar/ai/mcp/tools/reader.py:497) already handledNone. The only otheredgar/hits are differently named fields on proxy and Form 4 objects.Docs. There is a new
docs/upgrade/6.0.mdsection, and "Still to come" (now empty) becomes "Not in 6.0", which holds the module-moves note.docs/guides/schedule13dg-data-object-guide.mdis updated, including a stale paragraph that said the comparison "adds up the rows", which has been wrong since #1400.This branch includes #1620 (the guide review) merged in, because both edit the same table. Review or merge #1620 first.
Verification
total_sharesis 2,435,000 andtotal_percentis 9.9.total_shares,aggregate_amount,total_voting_powerandshares_changeareNone,total_percentstays 9.9, andpercent_changeis 0.0. 5.x reported that amendment as a 2,435,000-share decrease.tests/issues/regression/test_u6tkw_schedule13_unreported_is_none.py, 5 tests, all run with FutureWarning promoted to an error.test_issue_1379_schedule13_unreported_figures.pyasserted the 5.x placeholder 0s, the old change values and the FutureWarning. That is the behaviour this PR reverses, so they now assertNoneand no warning. The controls for reported zeros and real changes are unchanged.hatch run test-fast: 42,657 passed, 0 failed. After the guide merge, the 13D/G tests plus both docs gates pass (55 tests).Implemented by a Claude Code subagent (Claude Opus 5.5) and reviewed in the main session.
🤖 Generated with Claude Code