typing improvements

FHPythonUtils · Feb 19, 2025 · 218cd0d · 218cd0d
1 parent 0078c99
commit 218cd0d
Show file tree

Hide file tree

Showing 37 changed files with 280 additions and 287 deletions.
diff --git a/documentation/reference/gimpformats/GimpChannel.md b/documentation/reference/gimpformats/GimpChannel.md
@@ -54,7 +54,7 @@ Decode a byte buffer.
 #### Arguments
 
 ----
- - `data` *bytes* - data to decode
+ - `data` *bytearray* - data to decode
  - `index` *int, optional* - index to start from. Defaults to 0.
 
 #### Returns
@@ -65,7 +65,7 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes | bytearray, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpChannel().encode

diff --git a/documentation/reference/gimpformats/GimpGbrBrush.md b/documentation/reference/gimpformats/GimpGbrBrush.md
@@ -52,7 +52,7 @@ Decode a byte buffer.
 #### Arguments
 
 ----
- - `data` *bytes* - data buffer to decode
+ - `data` *bytearray* - data buffer to decode
  - `index` *int, optional* - index within the buffer to start at. Defaults to 0.
 
 #### Raises
@@ -69,7 +69,7 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpGbrBrush().encode

diff --git a/documentation/reference/gimpformats/GimpGgrGradient.md b/documentation/reference/gimpformats/GimpGgrGradient.md
@@ -57,7 +57,7 @@ Decode a byte buffer.
 #### Arguments
 
 ----
- - `dataIn` *bytes* - data buffer to decode
+ - `dataIn` *bytearray* - data buffer to decode
 
 #### Raises
 
@@ -67,19 +67,19 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, dataIn: bytes) -> None: ...
+def decode(self, dataIn: bytearray) -> None: ...
 ```
 
 ### GimpGgrGradient().encode
 
 [Show source in GimpGgrGradient.py:175](../../../gimpformats/GimpGgrGradient.py#L175)
 
-Encode this to bytes.
+Encode this to bytearray.
 
 #### Signature
 
 ```python
-def encode(self) -> bytes: ...
+def encode(self) -> bytearray: ...
 ```
 
 ### GimpGgrGradient().full_repr

diff --git a/documentation/reference/gimpformats/GimpGihBrushSet.md b/documentation/reference/gimpformats/GimpGihBrushSet.md
@@ -53,7 +53,7 @@ Decode a byte buffer.
 #### Arguments
 
 ----
- - `data` *bytes* - data buffer to decode
+ - `data` *bytearray* - data buffer to decode
  - `index` *int, optional* - index within the buffer to start at. Defaults to 0.
 
 #### Returns
@@ -64,19 +64,19 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpGihBrushSet().encode
 
 [Show source in GimpGihBrushSet.py:81](../../../gimpformats/GimpGihBrushSet.py#L81)
 
-Encode this object to bytes.
+Encode this object to bytearray.
 
 #### Signature
 
 ```python
-def encode(self) -> bytes: ...
+def encode(self) -> bytearray: ...
 ```
 
 ### GimpGihBrushSet().full_repr

diff --git a/documentation/reference/gimpformats/GimpGpbBrush.md b/documentation/reference/gimpformats/GimpGpbBrush.md
@@ -63,7 +63,7 @@ Decode a byte buffer.
 #### Arguments
 
 ----
- - `data` *bytes* - data to decode
+ - `data` *bytearray* - data to decode
  - `index` *int, optional* - index to start from. Defaults to 0.
 
 #### Returns
@@ -74,19 +74,19 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpGpbBrush().encode
 
 [Show source in GimpGpbBrush.py:60](../../../gimpformats/GimpGpbBrush.py#L60)
 
-Encode this object to bytes.
+Encode this object to bytearray.
 
 #### Signature
 
 ```python
-def encode(self) -> bytes | bytearray: ...
+def encode(self) -> bytearray: ...
 ```
 
 ### GimpGpbBrush().full_repr

diff --git a/documentation/reference/gimpformats/GimpGplPalette.md b/documentation/reference/gimpformats/GimpGplPalette.md
@@ -95,7 +95,7 @@ Encode to a raw data stream.
 #### Signature
 
 ```python
-def encode(self) -> bytes: ...
+def encode(self) -> bytearray: ...
 ```
 
 ### GimpGplPalette().full_repr

diff --git a/documentation/reference/gimpformats/GimpGtpToolPreset.md b/documentation/reference/gimpformats/GimpGtpToolPreset.md
@@ -72,19 +72,19 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpGtpToolPreset().encode
 
 [Show source in GimpGtpToolPreset.py:157](../../../gimpformats/GimpGtpToolPreset.py#L157)
 
-Encode to bytes.
+Encode to bytearray.
 
 #### Signature
 
 ```python
-def encode(self) -> bytes: ...
+def encode(self) -> bytearray: ...
 ```
 
 ### GimpGtpToolPreset().full_repr
@@ -195,7 +195,7 @@ Decode a parentheses-based file format.
 #### Signature
 
 ```python
-def parenFileDecode(data: bytes) -> list[ParenFileValue]: ...
+def parenFileDecode(data: bytearray) -> list[ParenFileValue]: ...
 ```
 
 #### See also

diff --git a/documentation/reference/gimpformats/GimpIOBase.md b/documentation/reference/gimpformats/GimpIOBase.md
@@ -147,14 +147,14 @@ _colormapDecode_.
 
 #### Arguments
 
-- `data` - can be bytes or an IO object
+- `data` - can be bytearray or an IO object
 
 decode colormap/palette
 
 #### Signature
 
 ```python
-def _colormapDecode(self, data: bytes | bytearray | IO, index: int = 0) -> None: ...
+def _colormapDecode(self, data: bytearray | IO, index: int = 0) -> None: ...
 ```
 
 ### GimpIOBase()._guidelinesDecode
@@ -166,7 +166,7 @@ Decode guidelines.
 #### Signature
 
 ```python
-def _guidelinesDecode(self, data: bytes | bytearray) -> None: ...
+def _guidelinesDecode(self, data: bytearray) -> None: ...
 ```
 
 ### GimpIOBase()._itemPathDecode
@@ -178,7 +178,7 @@ Decode item path.
 #### Signature
 
 ```python
-def _itemPathDecode(self, data: bytes | bytearray) -> None: ...
+def _itemPathDecode(self, data: bytearray) -> None: ...
 ```
 
 ### GimpIOBase()._parasitesDecode
@@ -190,7 +190,7 @@ Decode list of parasites.
 #### Signature
 
 ```python
-def _parasitesDecode(self, data: bytes | bytearray) -> int: ...
+def _parasitesDecode(self, data: bytearray) -> int: ...
 ```
 
 ### GimpIOBase()._parasitesEncode
@@ -247,7 +247,7 @@ data: varies but is often ioBuf.32 or ioBuf.boolean
 #### Signature
 
 ```python
-def _propertyDecode(self, prop: int, data: bytes | bytearray) -> int: ...
+def _propertyDecode(self, prop: int, data: bytearray) -> int: ...
 ```
 
 ### GimpIOBase()._propertyEncode
@@ -278,7 +278,7 @@ Decode a series of points.
 #### Signature
 
 ```python
-def _samplePointsDecode(self, data: bytes | bytearray) -> None: ...
+def _samplePointsDecode(self, data: bytearray) -> None: ...
 ```
 
 ### GimpIOBase()._userUnitsDecode
@@ -290,7 +290,7 @@ Decode a set of user-defined measurement units.
 #### Signature
 
 ```python
-def _userUnitsDecode(self, data: bytes | bytearray) -> None: ...
+def _userUnitsDecode(self, data: bytearray) -> None: ...
 ```
 
 ### GimpIOBase()._vectorsDecode
@@ -302,7 +302,7 @@ Decode vectors.
 #### Signature
 
 ```python
-def _vectorsDecode(self, data: bytes | bytearray) -> None: ...
+def _vectorsDecode(self, data: bytearray) -> None: ...
 ```
 
 ### GimpIOBase().activeVector
@@ -463,7 +463,7 @@ Decode a byte buffer.
 #### Arguments
 
 ----
- - `data` *bytes* - data buffer to decode
+ - `data` *bytearray* - data buffer to decode
  - `index` *int, optional* - index within the buffer to start at]. Defaults to 0.
 
 #### Returns
@@ -474,14 +474,14 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes | bytearray, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpUserUnits().encode
 
 [Show source in GimpIOBase.py:835](../../../gimpformats/GimpIOBase.py#L835)
 
-Convert this object to raw bytes.
+Convert this object to raw bytearray.
 
 #### Signature
 

diff --git a/documentation/reference/gimpformats/GimpImageHierarchy.md b/documentation/reference/gimpformats/GimpImageHierarchy.md
@@ -66,7 +66,7 @@ Decode packed pixels from a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpImageHierarchy().encode

diff --git a/documentation/reference/gimpformats/GimpImageLevel.md b/documentation/reference/gimpformats/GimpImageLevel.md
@@ -112,7 +112,7 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpImageLevel().encode

diff --git a/documentation/reference/gimpformats/GimpLayer.md b/documentation/reference/gimpformats/GimpLayer.md
@@ -77,7 +77,7 @@ Return the offset
 #### Arguments
 
 ----
- - `data` *bytes* - data buffer to decode
+ - `data` *bytearray* - data buffer to decode
  - `index` *int, optional* - index within the buffer to start at]. Defaults to 0.
 
 #### Returns
@@ -88,7 +88,7 @@ Return the offset
 #### Signature
 
 ```python
-def decode(self, data: bytes | bytearray, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpLayer().encode

diff --git a/documentation/reference/gimpformats/GimpParasites.md b/documentation/reference/gimpformats/GimpParasites.md
@@ -67,7 +67,7 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpParasite().encode

diff --git a/documentation/reference/gimpformats/GimpPatPattern.md b/documentation/reference/gimpformats/GimpPatPattern.md
@@ -65,7 +65,7 @@ Decode a byte buffer.
 #### Arguments
 
 ----
- - `data` *bytes* - data to decode
+ - `data` *bytearray* - data to decode
  - `index` *int, optional* - index to start from. Defaults to 0.
 
 #### Raises
@@ -81,7 +81,7 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, data: bytes, index: int = 0) -> int: ...
+def decode(self, data: bytearray, index: int = 0) -> int: ...
 ```
 
 ### GimpPatPattern().encode

diff --git a/documentation/reference/gimpformats/GimpVbrBrush.md b/documentation/reference/gimpformats/GimpVbrBrush.md
@@ -80,7 +80,7 @@ Decode a byte buffer.
 #### Signature
 
 ```python
-def decode(self, dataIn: bytes) -> None: ...
+def decode(self, dataIn: bytearray) -> None: ...
 ```
 
 ### GimpVbrBrush().encode
@@ -92,7 +92,7 @@ Encode to a raw data stream.
 #### Signature
 
 ```python
-def encode(self) -> bytes: ...
+def encode(self) -> bytearray: ...
 ```
 
 ### GimpVbrBrush().image