RFC: nameparser 2.0 — a new core API#285
Merged
Merged
Conversation
The design document for 2.0: a new immutable core API (parse() -> ParsedName, Lexicon/Policy configuration) alongside HumanName as a compatibility layer through 2.x. Covers the compatibility promise, the new API, migration mechanics, locale plans, rejected alternatives, and the feedback questions. Discussion: #284. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Repository owner
deleted a comment from
codecov-commenter
Jul 12, 2026
derek73
added a commit
that referenced
this pull request
Jul 24, 2026
2.0.0rc1 shipped to PyPI, so "2.0 is in design" is stale. Point the notice at the release candidate: pip install --pre nameparser (a plain install still gets 1.x) and the version-pinned 2.0 docs. Dropped the design-RFC link (#285) since the design is now running code; kept the #284 feedback issue. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Owner
Author
Two reconciliations before merging the RFC as the standing design record. The design did not drift -- it grew after this doc froze on 2026-07-11 -- so nothing here contradicted the release; it was missing a field and carried an illustrative string that never matched output. - Add the `maiden` field (#274), decided after the RFC was written: a birth surname introduced by a marker like née/geb. that v1 folded into middle/last. It is the one user-facing 2.0 field the document omitted. - Fix the ambiguity example's detail text to the actual shipped string ("leading 'Van' may be a family-name particle; read as a given name"). Detail text is not stable API, but an example that does not reproduce is a wart in a standing record. Verified every other code example in the RFC runs verbatim against 2.0.0rc1 -- replace(), the Token repr, the FAMILY_FIRST example, the RU locale, and the "not in 2.0" claim for parse_all()/explain(). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #285 +/- ##
==========================================
- Coverage 97.70% 97.67% -0.04%
==========================================
Files 13 13
Lines 917 947 +30
==========================================
+ Hits 896 925 +29
- Misses 21 22 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
1 participant
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.
TL;DR: if you only use
HumanNameand never customize configuration, 2.0 should be a non-event for you — but it's cool and we'd love your feedback anyway.This PR adds a design document:
docs/design/nameparser-2.0-rfc.md, the RFC for nameparser 2.0 — a new immutable core API (parse()→ParsedName,Lexicon/Policyconfiguration) alongsideHumanName, which continues to work as a compatibility layer through all of 2.x.This PR is documentation-only and will stay that way. Implementation happens on separate branches with their own PRs; what lands here are amendments to the design as implementation and feedback teach us things.
How to review:
==? subclass? mutateCONSTANTSlate? custom regexes?) → the discussion issue: nameparser 2.0: a new core API, with full compatibility through 2.x — direction and feedback #284.There is no comment deadline. The PR stays open while the design settles; merging it marks the design stable (likely around the first 2.0 alpha) and keeps the document in
docs/design/as the standing record. The design may change in response to comments right up to that point — that's what this is for.🤖 Generated with Claude Code