SanDisk-Open-Source / pyvcd / 80

100%

push

travis-ci

Use enum for scope type, var type, and timescale

For increased type clarity and for more automatic error handling, the
lists of str used for valid scope types, var types, timescale magnitudes,
and timescale units are converted into Enum subclasses.

Compatibility:

Clients calling VCDWriter(), VCDWriter.set_scope_type() and
VCDWriter.register_var() may still pass str values for scope type, var
type, and timescale. These str values are converted into enum items
under-the-hood. So all previously valid calls to VCDWriter and its methods
remain valid.

The SCOPE_TYPES, VAR_TYPES, TIMESCALE_NUMS, and TIMESCALE_UNITS class
attributes of VCDWriter are removed. Any client referencing those class
attrs will need to be updated to reference the new top-level ScopeType,
VarType, TimescaleMagnitude, and TimescaleUnit enums.

Any references to Variable.type will now get a VarType instance instead of
a str instance. Referencing Variable.type.value instead will provide a
compatible str value.

294 of 294 branches covered (100.0%)

Branch coverage included in aggregate %.

65 of 65 new or added lines in 1 file covered. (100.0%)

600 of 600 relevant lines covered (100.0%)

1.0 hits per line