gedcomkit 0.1.17__tar.gz → 0.1.19__tar.gz

{gedcomkit-0.1.17 → gedcomkit-0.1.19}/CHANGELOG.md

@@ -5,6 +5,217 @@ format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 the project uses semantic versioning within the usual pre-1.0 compatibility
 rules.
 
+## [Unreleased]
+
+## [0.1.19] - 2026-10-17
+
+### Added
+
+- `view::EventView::date_phrase` (`datePhrase` in the serialized view, so
+  in both bindings and the TypeScript definitions): the `PHRASE` beneath an
+  event's `DATE`, exactly as written. A GEDCOM 7 date with an empty payload
+  and a `PHRASE`, or a date with a phrase beside it, showed nothing of the
+  phrase before. A 5.5.1 phrase is written inside the payload, which `date`
+  already holds. The Python stub gains an `EventView` typed dict naming
+  every key of an event.
+- The date reader reads ISO 8601's year and month: `1834-02` is February
+  1834, as `1834-02-10` was already 10 February 1834. Only four digits, a
+  hyphen and two digits are read, and only when the month is no more than
+  the year's last two digits: `1808-10`, `1711-12` and `2010-11` are as
+  often a span of years or a dual year as a month, and stay unparsed. So
+  does every month of a year ending in 00 (`1800-01` to `1800-12`), and
+  the later months of a year ending in 01 to 11 (`2005-06` to `2005-12`).
+
+### Changed
+
+- `validate::inspect` no longer reports two events out of order when an
+  approximate date's leeway could put them in order, which is how
+  `conflicting-vitals` already read them. A birth `ABT 1854` with a
+  christening in 1853 was a `christened-before-born` question; it is now
+  no finding. The same holds for `died-before-born`, `buried-before-died`,
+  `event-after-death`, `event-before-birth`, `married-before-born`,
+  `married-after-died` and `child-born-after-mother-died`, each of which
+  now reports only what is out of order beyond the leeway, as a
+  contradiction (a question for an `EVEN` or `FACT`, as before). Within the
+  leeway no other check fires in its place: a marriage in 1849 for somebody
+  born about 1850 is not `married-as-a-child`. Bounds (`BEF`, `AFT`, `BET`)
+  are read as the ranges they admit, unchanged.
+- `convert::to_version_5_5_1` turns a name type back into 5.5.1's
+  spelling: `OTHER` with a one-line `PHRASE` becomes the phrase's words,
+  and an enumerated value is written in lower case (`BIRTH` becomes
+  `birth`). `OTHER` whose words are themselves an enumerated value (the
+  phrase `birth`) stays `other`, its `PHRASE` kept and reported, since the
+  words alone would convert back up as `BIRTH`. A `PHRASE` beside any other
+  value is kept and reported.
+- `DatePoint::from_ymd` refuses a day its month never has (30 February,
+  31 April, day 0). The point is written with no calendar escape, which
+  makes it Gregorian, so 29 February is taken only in a Gregorian leap
+  year: 2000, not 1900.
+
+### Fixed
+
+- A range with an end the date reader cannot read is no longer read in
+  part. `FROM ABT 1924 TO 1959` was read as `TO 1959`, dropping the start
+  without a word, and `BET 1950 AND JULIAN DEC 302` as a range with only
+  its first end; `FROM Infant` was a period with neither end. Each is now
+  `DateKind::Unparsed`, keeps its text as the phrase, and still offers its
+  year to sort by; `to_version_7` keeps it whole as an empty `DATE` with a
+  `PHRASE`. A range whose ends are both dates reads as before.
+- The date reader no longer accepts a day its month does not have.
+  `1834-02-30` and `30 FEB 1834` were read as 30 February 1834; they are
+  now unparsed, as is `29 FEB 1834`. Leap years follow the payload's
+  calendar: `@#DJULIAN@ 29 FEB 1900` is read and `@#DGREGORIAN@ 29 FEB
+  1900` is not. A payload with no calendar escape keeps the Julian leap
+  day, since files often leave the escape off a Julian date, so
+  `29 FEB 1900` is still read; ISO 8601's `1900-02-29` is not, since ISO
+  8601 is Gregorian by definition. A dual year's leap day is its second
+  year's, so `29 FEB 1711/12` and `@#DJULIAN@ 29 FEB 1711/12` are read. A
+  Roman or unrecognized calendar is held to the Julian month lengths, and
+  no Hebrew or French Republican month has more than 30 days. A numeric
+  date with a month or day out of range (`1834-13-05`, `13/05/1834`) is
+  unparsed too; before, the piece out of range was dropped and the rest
+  read (`1834-13-05` as the year 1834).
+- `convert::to_version_5_5_1` no longer writes `INT  (…)`, an interpreted
+  date with no date, for a version 7 `DATE` that is empty beside its
+  `PHRASE`; 5.5.1 does not allow it. The phrase is written as 5.5.1's date
+  phrase, `(FROM ABT 1924 TO 1959)`, or as the date itself when it is
+  already one in 5.5.1's grammar that version 7 cannot spell, so a dual
+  year (`1740/41`) comes back as the date it was.
+- `convert::to_version_7` / `to_version_7_with` convert a personal name's
+  type (`INDI`.`NAME`.`TYPE`), which 5.5.1 writes as free text and version
+  7 as an enumeration. A value that is one of version 7's words in any case
+  (`aka`, `birth`, `immigrant`, `maiden`, `married`, `professional`,
+  `other`) becomes that word in upper case; any other becomes `OTHER`, with
+  the text kept verbatim as a `PHRASE`, the way a role has been converted
+  since 0.1.13. Before, `TYPE aka` was carried into the 7.0 document as it
+  stood, where it is not valid. A type that already has a `PHRASE`, is
+  empty, or has a continuation line with substructures is kept and
+  reported.
+
+## [0.1.18] - 2026-10-16
+
+### Added
+
+- `validate::inspect` runs nine more checks. Each has a stable name, and
+  the module documentation now lists every check with its severity:
+  - `married-after-died` (contradiction): a family's first `MARR` wholly
+    after a partner's death, or, failing a dated death, their burial. A
+    burial before the wedding beside a death after it is no finding here:
+    the death says when the life ended, and the burial is
+    `buried-before-died`'s.
+  - `child-born-long-after-father-died`: a child born more than 300 days
+    after the death of the family's `HUSB`. A contradiction when both dates
+    name a day; a question otherwise, since a bare year is often a guess.
+  - `christened-before-born` (contradiction): a `CHR`, `CHRA` or `BAPM`
+    wholly before the birth.
+  - `event-before-birth`: the mirror of `event-after-death`, for any other
+    event or attribute wholly before the birth year. A burial or cremation
+    is left to `died-before-born` and `buried-before-died` when the person
+    has a dated death.
+  - `buried-long-after-died` (question): a burial more than 365 days after
+    the death, counted from the latest day the death allows to the earliest
+    the burial does.
+  - `children-too-close`: two children of one mother born 2 to 270 days
+    apart. A contradiction when both dates name a day and are under 150
+    days apart; a question otherwise, since a very early birth makes the
+    longer gaps possible. A mother's children are taken from every family
+    she is the `WIFE` in; a family with no `WIFE` is compared alone.
+  - `possible-duplicate-child` (question): two children of one mother with
+    one given name (one name may be the start of the other: `Mira` and
+    `Mira Elowen`, but not `Mira Elowen` and `Mira Rose`), born on one
+    date, or on one day and month of different years.
+  - `conflicting-vitals` (question): two `BIRT`, or two `DEAT`, events of
+    one person that cannot both be true, even with an approximate date
+    allowed a year either way (`BIRT 1851` and `BIRT ABT 1850` are not in
+    conflict). GEDCOM lets a file record alternatives with the preferred
+    first, which is the one the other checks read, so this asks rather
+    than accuses.
+  - `own-ancestor` (contradiction): a loop in the parent links, read from
+    both directions of the family link as `FamilyGraph` reads them. One
+    finding per loop, on the person in it the file lists first, naming the
+    shortest way round: in full up to six steps, and past that its first
+    five and how many more, so a loop through 20,000 people is one short
+    message.
+
+  The three checks that compare pairs are bounded, so a hostile file cannot
+  make the report as large as the square of its people. `children-too-close`
+  and `possible-duplicate-child` report at most ten pairs for one mother,
+  and `conflicting-vitals` ten for one person's births and ten for their
+  deaths, the first in the order the file lists them; one more finding under
+  the same check, as serious as the most serious pair it stands for, then
+  says how many more pairs there are and how many in all (`4059990 more
+  pairs of children born 2 to 270 days apart, 4060000 in all`). The work is
+  bounded too: births and deaths are counted by sorting rather than compared
+  pair by pair; children who share a span of birth days, or a given name,
+  are compared as one group; and one mother's children are compared at most
+  100,000 times for each check, past which the summary gives its counts as
+  lower bounds. A family of 3,000 children of one name born in one month,
+  which made 4.5 million sibling findings, makes 22; a person with 5,000
+  births, which made 12.5 million `conflicting-vitals` findings, makes 11.
+
+### Changed
+
+- PyPI gets one wheel, Linux x86_64, beside the source distribution. The
+  macOS and Windows wheels are no longer cross-built; on those platforms pip
+  builds from the sdist, which needs a Rust toolchain.
+- `died-before-born`, `buried-before-died`, `christened-before-born`,
+  `married-after-died` and `conflicting-vitals` compare as finely as both
+  dates allow: a burial on 12 September before a death on 14 September of
+  one year is now found. Julian and Gregorian dates are put on one count of days first.
+  An approximate date (`ABT`, `CAL`, `EST`) still vouches for its year and
+  nothing finer, and a bound (`BEF`, `AFT`, `BET`) admits its own day. A
+  finding the years alone decide keeps its wording (`born 1900 and died
+  1880`); one only a finer comparison finds names the dates in full
+  (`died 14 September 1862 and buried 12 September 1862`).
+- An approximate date (`ABT`, `CAL`, `EST`) may be a year out. A finding
+  that two events are out of order is a question, not a contradiction, when
+  moving each approximate date a year either way could put them in order:
+  `BIRT ABT 1850` with `CHR 1849` or `CENS 1849`, or `DEAT ABT 1850` with a
+  burial in 1849. Two years out it is still a contradiction. This holds for
+  `died-before-born`, `buried-before-died`, `event-after-death`,
+  `married-before-born` and `child-born-after-mother-died`, and for the new
+  `christened-before-born`, `event-before-birth` and `married-after-died`;
+  the checks about an age or an interval take an approximate year as
+  written. Their messages say an approximate date is one: `born about 1850,
+  and Christening is dated 1849`.
+- `event-after-death` is a question, not a contradiction, for an `EVEN` or
+  `FACT`. Such an event is whatever its free-text `TYPE` says — a land
+  entry completed, a patent issued, an estate settled — and many of those
+  are done in a dead person's name. The other events keep their severity.
+- `by` is read as a `BEF` qualifier: `by 5 October 1752` is
+  `BEF 5 OCT 1752`, where it was read as 5 May 1752. The qualifiers the
+  reader already knew (`abt`, `about`, `c.`, `ca.`, `bef`, `before`, `aft`,
+  `after`, and the others) are unchanged.
+
+### Fixed
+
+- The date reader no longer shifts the pieces of a four-word date around a
+  word it does not know. `chr 10 Nov 1788` read as 10 October 1788,
+  `b 9 Jun 1750` as 9 September, `bapt. 3 May 1801` as 3 March: the leading
+  word was tried as a month, failed, and the day number was taken as the
+  month instead. Four pieces are now read only as a day, its ordinal ending
+  and a month written as a word, in either order (`Feb 11 th 1809`,
+  `11 th Feb 1809`, `1er janvier 1800`, `5te Januar 1800`); anything else is
+  `DateKind::Unparsed`, keeps its text as the phrase, and still offers its
+  year to sort by, so `to_gedcom_5_5_1` and `to_gedcom_7` return `None` and
+  the caller writes it as a date phrase. A month given only as a number never
+  decides the order of four pieces.
+- A dual year (`10 JAN 1731/32`) admits both its years in every check, not
+  only where days are compared. The checks that compare years read it as
+  its first year alone, so `BIRT 1732` with `DEAT 10 JAN 1731/32` was
+  `died-before-born` ("born 1732 and died 1731"); it is now no finding, and
+  a death past both years says `died between 1731 and 1732`. Where the days
+  of two dates are compared, they alone decide the order, so a burial in the
+  Julian year 1700, which runs eleven days into the Gregorian 1701, is no
+  longer wholly before a death in the Gregorian 1701.
+- `child-listed-twice` keeps the children it has seen in a set rather than
+  a list, so a family listing tens of thousands of children is checked in
+  time proportional to their number, not its square.
+- The checks on an individual's own record read that record's dates when it
+  has no identifier, or shares one with another record. Before, such a
+  record was checked against no dates, or against those of the last record
+  with its identifier.
+
 ## [0.1.17] - 2026-10-16
 
 ### Changed

{gedcomkit-0.1.17 → gedcomkit-0.1.19}/Cargo.lock

@@ -35,7 +35,7 @@ dependencies = [
 
 [[package]]
 name = "gedcomkit"
-version = "0.1.17"
+version = "0.1.19"
 dependencies = [
  "flate2",
  "serde",

{gedcomkit-0.1.17 → gedcomkit-0.1.19}/Cargo.toml

@@ -3,7 +3,7 @@
 # was checked on crates.io, npm, and PyPI before the initial release.
 [package]
 name = "gedcomkit"
-version = "0.1.17"
+version = "0.1.19"
 description = "A byte-preserving GEDCOM document model: decoding, parsing, readings, version conversion, plausibility checks, and the GEDZIP container, for GEDCOM 5.5 through 7.x."
 edition = "2024"
 # The true minimum, not the workspace's toolchain: a parser library is a leaf

{gedcomkit-0.1.17 → gedcomkit-0.1.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gedcomkit
-Version: 0.1.17
+Version: 0.1.19
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython

{gedcomkit-0.1.17 → gedcomkit-0.1.19}/README.md

@@ -23,6 +23,9 @@ Python:
 python -m pip install gedcomkit
 ```
 
+Wheels are published for Linux x86_64 only. Elsewhere pip builds the package from
+source, which needs a Rust toolchain ([rustup](https://rustup.rs)).
+
 Node.js / WASM:
 
 ```bash

{gedcomkit-0.1.17 → gedcomkit-0.1.19}/bindings/gedcomkit-py/Cargo.lock

@@ -35,7 +35,7 @@ dependencies = [
 
 [[package]]
 name = "gedcomkit"
-version = "0.1.17"
+version = "0.1.19"
 dependencies = [
  "flate2",
  "serde",
@@ -43,7 +43,7 @@ dependencies = [
 
 [[package]]
 name = "gedcomkit-py"
-version = "0.1.17"
+version = "0.1.19"
 dependencies = [
  "gedcomkit",
  "pyo3",

{gedcomkit-0.1.17 → gedcomkit-0.1.19}/bindings/gedcomkit-py/Cargo.toml

@@ -2,7 +2,7 @@
 # abi3 keeps it to one wheel per platform across Python versions.
 [package]
 name = "gedcomkit-py"
-version = "0.1.17"
+version = "0.1.19"
 description = "Python bindings for gedcomkit: an archival-grade GEDCOM library — byte-preserving round-trip, encoding detection, GEDCOM 5.5 through 7.x, GEDZIP."
 edition = "2024"
 rust-version = "1.88"

{gedcomkit-0.1.17 → gedcomkit-0.1.19}/bindings/gedcomkit-py/gedcomkit.pyi

@@ -19,6 +19,29 @@ class RecordSpec(TypedDict):
     value: NotRequired[str | None]
     children: NotRequired[list[RecordSpec]]
 
+class EventView(TypedDict):
+    """One entry of an individual's or a family's ``events``.
+
+    ``date`` is the DATE payload exactly as written. ``datePhrase`` is the
+    GEDCOM 7 PHRASE beneath that DATE, or ``None``: beside a date, or the
+    only text an empty 7.0 DATE has. A 5.5.1 phrase is part of ``date``.
+    """
+
+    tag: str
+    label: str
+    date: str | None
+    datePhrase: str | None
+    dateDisplay: str | None
+    year: int | None
+    sortKey: int | None
+    place: str | None
+    age: str | None
+    cause: str | None
+    attribute: bool
+    value: str | None
+    citations: list[str]
+    path: list[int]
+
 class WrappedLine(TypedDict):
     record: str
     path: list[int]
@@ -42,9 +65,15 @@ class Gedcom:
     def content_records(self) -> int: ...
     def records(self) -> list[dict[str, Any]]: ...
     def record(self, xref: str) -> dict[str, Any]: ...
-    def individuals(self) -> list[dict[str, Any]]: ...
-    def families(self) -> list[dict[str, Any]]: ...
-    def validate(self) -> list[dict[str, Any]]: ...
+    def individuals(self) -> list[dict[str, Any]]:
+        """Every individual's view; each of its ``events`` is an ``EventView``."""
+    def families(self) -> list[dict[str, Any]]:
+        """Every family's view; each of its ``events`` is an ``EventView``."""
+    def validate(self) -> list[dict[str, Any]]:
+        """Plausibility findings, each with ``record``, ``check``, ``severity``
+        and ``message``. ``check`` is the core's stable rule name, such as
+        ``died-before-born`` or ``own-ancestor``; the core's ``validate``
+        module documentation lists every one with its severity."""
     def unresolved_pointers(self) -> list[dict[str, Any]]: ...
     def parents_of(self, xref: str) -> list[str]: ...
     def children_of(self, xref: str) -> list[str]: ...

{gedcomkit-0.1.17 → gedcomkit-0.1.19}/bindings/gedcomkit-py/src/lib.rs

@@ -224,6 +224,8 @@ impl Gedcom {
     }
 
     /// Every individual, read for display: names, events, families, IDs.
+    /// Each event has its `date` payload as written and, beside it,
+    /// `datePhrase`: the GEDCOM 7 `PHRASE` under the date, or `None`.
     fn individuals(&self, py: Python<'_>) -> PyResult<Vec<Py<PyAny>>> {
         self.document
             .records_of("INDI")
@@ -231,7 +233,7 @@ impl Gedcom {
             .collect()
     }
 
-    /// Every family record's view.
+    /// Every family record's view, its events shaped as `individuals`' are.
     fn families(&self, py: Python<'_>) -> PyResult<Vec<Py<PyAny>>> {
         self.document
             .records_of("FAM")
@@ -240,7 +242,10 @@ impl Gedcom {
     }
 
     /// Plausibility findings: contradictions, questions, and what cites
-    /// nothing — reported with the numbers they were drawn from.
+    /// nothing — reported with the numbers they were drawn from. Each has
+    /// `record`, `check`, `severity` and `message`; `check` is the core's
+    /// stable rule name (`died-before-born`, `own-ancestor`, …), listed with
+    /// its severity in the core's `validate` module documentation.
     fn validate(&self, py: Python<'_>) -> PyResult<Vec<Py<PyAny>>> {
         gedcomkit::validate::inspect(&self.document)
             .iter()