🐞 `Track.color` returns `int` instead of `colour.Color`

[demberto]

PyFLP/pyflp/arrangement.py

Line 308 in 4a063da

color = StructProp[colour.Color](id=TrackID.Data)

Solution 1; Change StructBase to encode and decode colour.Color directly into StructEvent._props

PyFLP/pyflp/_base.py

Lines 521 to 530 in 4a063da

	def __init__(self, stream: BytesIOEx):
	self._props: dict[str, Any] = dict.fromkeys(type(self).PROPS)
	self._stream = stream
	self._stream_len = len(stream.getvalue())
	for key, type_or_size in type(self).PROPS.items():
	if isinstance(type_or_size, int):
	self._props[key] = self._stream.read(type_or_size)
	else:
	self._props[key] = getattr(self._stream, f"read_{type_or_size}")()

PyFLP/pyflp/_base.py

Lines 544 to 557 in 4a063da

	def __setitem__(self, key: str, value: Any):
	if key not in type(self).PROPS:
	raise KeyError(key)
	self._stream.seek(type(self).OFFSETS[key])
	type_or_size = type(self).PROPS[key]
	if isinstance(type_or_size, int):
	self._stream.write(value)
	else:
	getattr(self._stream, f"write_{type_or_size}")(value)
	if len(self._stream.getvalue()) > self._stream_len and self.TRUNCATE:
	raise PropertyCannotBeSet
	self._props[key] = value

Solution 2: Add a ColorProp to pyflp._base, specifically for colours encoded in variable sized events

This is the better option imo, because it will not modify StructEvent._props, which will be used to store event values without any type of interpretation (mainly for debugging purposes). Using the first solution also breaks one of the highlights of PyFLP 2.0.0 - zero pre-parse validation.

[demberto]

I chose to do a local _TrackColorProp instead, will refactor to Solution 2 if needed. Modified ColorEvent to avoid code duplication.

PyFLP/pyflp/arrangement.py

Lines 280 to 288 in f71c62b

	class _TrackColorProp(StructProp[colour.Color]):
	def __get__(self, instance: ModelBase, owner: Any = None):
	value = cast(int | None, super().__get__(instance, owner))
	if value is not None:
	return ColorEvent.decode(value.to_bytes(4, "little"))
	def __set__(self, instance: ModelBase, value: colour.Color):
	color_u32 = int.from_bytes(ColorEvent.encode(value), "little")
	super().__set__(instance, color_u32) # type: ignore