Qiskit / qiskit / 35887579521

88%

main: 88%

Build Type

push

github

Committed by web-flow

Commit Message

Give data trees validated names, structures, and dotted paths (#16912)

* Give data trees validated names, structures, and dotted paths

A name is now validated on construction: nonempty, containing no `.`, and not
consisting only of digits. Those rules are what make a dotted path unambiguous,
so a segment of digits addresses a child by position and any other segment
addresses one by name. Rejection is recoverable rather than a panic, because
names come from caller data. `get_by_str_key` becomes `resolve`, since a segment
is no longer always a name, and `iter_path` reports a named child by name, which
is what `dotted_paths` needs to address the same leaf it names.

Naming a slot that a branch already carries replaces that child in place. Pushing
the new child and rebinding the key left the previous one behind as an unnamed
sibling, which silently changed a branch's arity.

`structure()` returns the tree with its leaf values erased, so two trees that
differ only in their values compare equal. It is not called a shape: `TensorType`
and `Tensor` already use that word for tensor axes, and a program function will
carry both a shape per slot and a structure over its slots.

`sequence` and `mapping` build a branch immutably, which is how the type
specifications in the op catalogue and every new caller construct one.

Resolving an out-of-range position now reports rather than panicking.

* update to Partial/Ord and change error strings

* Stop deriving Clone, PartialEq and Eq on data tree errors

An error type that derives these traits commits every future variant, and every
error it nests, to deriving them too. The tests that compared error values now
match on them instead.

* Make Name private

Coverage Stats

384 of 386 new or added lines in 5 files covered. (99.48%)

12 existing lines in 4 files now uncovered.

118983 of 135392 relevant lines covered (87.88%)

969210.3 hits per line