canonical_name
A dotted name that serves as a unique identifier for this
ValueDoc's value. If the value can be reached using a
single sequence of identifiers (given the appropriate imports), then that
sequence of identifiers is used as its canonical name. If the value can
be reached by multiple sequences of identifiers (i.e., if it has multiple
aliases), then one of those sequences of identifiers is used. If the
value cannot be reached by any sequence of identifiers (e.g., if it was
used as a base class but then its variable was deleted), then its
canonical name will start with '??'. If necessary, a dash
followed by a number will be appended to the end of a non-reachable
identifier to make its canonical name unique.
When possible, canonical names are chosen when new
ValueDocs are created. However, this is sometimes not
possible. If a canonical name can not be chosen when the
ValueDoc is created, then one will be assigned by assign_canonical_names().
-
- Type:
- DottedName
- Value:
|
