feat: experiment replacing pylint with ruff + pyright

Author: FredHappyface

.pre-commit-config.yaml

@@ -1,44 +1,32 @@
 repos:
-  - repo: https://github.com/FHPythonUtils/Blackt
-    rev: '2022.0.3'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.13
     hooks:
-      - id: blackt
+      - id: ruff
+        args: [ --fix ]
 
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.347
     hooks:
-      - id: isort
+    - id: pyright
 
-  - repo: https://github.com/pycqa/pylint
-    rev: v3.0.0a6
+  - repo: https://github.com/FHPythonUtils/Blackt
+    rev: '2024'
     hooks:
-      - id: pylint
-        exclude: "tests/"
-        args: [--disable=import-error,--jobs=0]
+      - id: blackt
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
-        exclude: "tests/"
       - id: end-of-file-fixer
-        exclude: "tests/"
 
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.7.0
-    hooks:
-      - id: pyupgrade
-        args: [--py38-plus]
   - repo: https://github.com/boidolr/pre-commit-images
-    rev: v1.2.1
+    rev: v1.5.1
     hooks:
-      - id: optimize-avif
-        exclude: "tests/"
       - id: optimize-jpg
-        exclude: "tests/"
       - id: optimize-png
-        exclude: "tests/"
       - id: optimize-svg
-        exclude: "tests/"
       - id: optimize-webp
-        exclude: "tests/"
+
+exclude: "tests/data|documentation/reference"

documentation/reference/layeredimage/blend.md

@@ -1,8 +1,6 @@
 # Blend
 
-[Layeredimage Index](../README.md#layeredimage-index) /
-[Layeredimage](./index.md#layeredimage) /
-Blend
+[Layeredimage Index](../README.md#layeredimage-index) / [Layeredimage](./index.md#layeredimage) / Blend
 
 > Auto-generated documentation for [layeredimage.blend](../../../layeredimage/blend.py) module.
 - [Blend](#blend)

documentation/reference/layeredimage/index.md

@@ -1,7 +1,6 @@
 # Layeredimage
 
-[Layeredimage Index](../README.md#layeredimage-index) /
-Layeredimage
+[Layeredimage Index](../README.md#layeredimage-index) / Layeredimage
 
 > Auto-generated documentation for [layeredimage](../../../layeredimage/__init__.py) module.
 

documentation/reference/layeredimage/io/common.md

@@ -1,9 +1,6 @@
 # Common
 
-[Layeredimage Index](../../README.md#layeredimage-index) /
-[Layeredimage](../index.md#layeredimage) /
-[Io](./index.md#io) /
-Common
+[Layeredimage Index](../../README.md#layeredimage-index) / [Layeredimage](../index.md#layeredimage) / [Io](./index.md#io) / Common
 
 > Auto-generated documentation for [layeredimage.io.common](../../../../layeredimage/io/common.py) module.
 

documentation/reference/layeredimage/io/gif.md

@@ -1,9 +1,6 @@
 # Gif
 
-[Layeredimage Index](../../README.md#layeredimage-index) /
-[Layeredimage](../index.md#layeredimage) /
-[Io](./index.md#io) /
-Gif
+[Layeredimage Index](../../README.md#layeredimage-index) / [Layeredimage](../index.md#layeredimage) / [Io](./index.md#io) / Gif
 
 > Auto-generated documentation for [layeredimage.io.gif](../../../../layeredimage/io/gif.py) module.
 
@@ -13,7 +10,7 @@ Gif
 
 ## openLayer_GIF
 
-[Show source in gif.py:14](../../../../layeredimage/io/gif.py#L14)
+[Show source in gif.py:12](../../../../layeredimage/io/gif.py#L12)
 
 Open a .gif file into a layered image.
 
@@ -27,7 +24,7 @@ def openLayer_GIF(file: str) -> LayeredImage: ...
 
 ## saveLayer_GIF
 
-[Show source in gif.py:32](../../../../layeredimage/io/gif.py#L32)
+[Show source in gif.py:30](../../../../layeredimage/io/gif.py#L30)
 
 Save a layered image as .gif.
 

documentation/reference/layeredimage/io/index.md

@@ -1,8 +1,6 @@
 # Io
 
-[Layeredimage Index](../../README.md#layeredimage-index) /
-[Layeredimage](../index.md#layeredimage) /
-Io
+[Layeredimage Index](../../README.md#layeredimage-index) / [Layeredimage](../index.md#layeredimage) / Io
 
 > Auto-generated documentation for [layeredimage.io](../../../../layeredimage/io/__init__.py) module.
 
@@ -15,7 +13,7 @@ Io
 
 ## exportFlatImage
 
-[Show source in __init__.py:103](../../../../layeredimage/io/__init__.py#L103)
+[Show source in __init__.py:109](../../../../layeredimage/io/__init__.py#L109)
 
 Export the layered image to a unilayer image file.
 
@@ -49,16 +47,19 @@ Open a layer image file into a layer image object.
 
 #### Arguments
 
-- `file` *str* - path/ filename
+----
+ - `file` *str* - path/ filename
 
 #### Raises
 
-- `FileExistsError` - If the layered image does not exist
-- `ValueError` - If the extention is not recognised
+------
+ - `FileExistsError` - If the layered image does not exist
+ - `ValueError` - If the extention is not recognised
 
 #### Returns
 
-- `LayeredImage` - a layered image object
+-------
+ - `LayeredImage` - a layered image object
 
 #### Signature
 
@@ -70,22 +71,25 @@ def openLayerImage(file: str | Path) -> LayeredImage: ...
 
 ## saveLayerImage
 
-[Show source in __init__.py:70](../../../../layeredimage/io/__init__.py#L70)
+[Show source in __init__.py:73](../../../../layeredimage/io/__init__.py#L73)
 
 Save a layered image to a file.
 
 #### Arguments
 
-- `fileName` *str* - path/ filename
-- `layeredImage` *LayeredImage* - the layered image to save
+----
+ - `fileName` *str* - path/ filename
+ - `layeredImage` *LayeredImage* - the layered image to save
 
 #### Raises
 
-- `ValueError` - If the extention is not recognised
+------
+ - `ValueError` - If the extention is not recognised
 
 #### Returns
 
-None
+-------
+ None
 
 #### Signature
 

documentation/reference/layeredimage/io/layered.md

@@ -1,23 +1,37 @@
 # Layered
 
-[Layeredimage Index](../../README.md#layeredimage-index) /
-[Layeredimage](../index.md#layeredimage) /
-[Io](./index.md#io) /
-Layered
+[Layeredimage Index](../../README.md#layeredimage-index) / [Layeredimage](../index.md#layeredimage) / [Io](./index.md#io) / Layered
 
 > Auto-generated documentation for [layeredimage.io.layered](../../../../layeredimage/io/layered.py) module.
 
 - [Layered](#layered)
+  - [_saveLayer_LAYERED](#_savelayer_layered)
   - [grabLayer_LAYERED](#grablayer_layered)
   - [openLayer_LAYERED](#openlayer_layered)
   - [openLayer_LAYEREDC](#openlayer_layeredc)
   - [saveLayer_LAYERED](#savelayer_layered)
   - [saveLayer_LAYEREDC](#savelayer_layeredc)
   - [writeImage_LAYERED](#writeimage_layered)
 
+## _saveLayer_LAYERED
+
+[Show source in layered.py:101](../../../../layeredimage/io/layered.py#L101)
+
+Save a layered image as .layered.
+
+#### Signature
+
+```python
+def _saveLayer_LAYERED(
+    fileName: str, layeredImage: LayeredImage, compressed: bool = False
+) -> None: ...
+```
+
+
+
 ## grabLayer_LAYERED
 
-[Show source in layered.py:83](../../../../layeredimage/io/layered.py#L83)
+[Show source in layered.py:81](../../../../layeredimage/io/layered.py#L81)
 
 Grab an image from .layered.
 
@@ -33,7 +47,7 @@ def grabLayer_LAYERED(
 
 ## openLayer_LAYERED
 
-[Show source in layered.py:21](../../../../layeredimage/io/layered.py#L21)
+[Show source in layered.py:19](../../../../layeredimage/io/layered.py#L19)
 
 Open a .layered file into a layered image.
 
@@ -47,7 +61,7 @@ def openLayer_LAYERED(file: str) -> LayeredImage: ...
 
 ## openLayer_LAYEREDC
 
-[Show source in layered.py:133](../../../../layeredimage/io/layered.py#L133)
+[Show source in layered.py:131](../../../../layeredimage/io/layered.py#L131)
 
 Open a .layeredc file into a layered image.
 
@@ -61,7 +75,7 @@ def openLayer_LAYEREDC(file: str) -> LayeredImage: ...
 
 ## saveLayer_LAYERED
 
-[Show source in layered.py:98](../../../../layeredimage/io/layered.py#L98)
+[Show source in layered.py:96](../../../../layeredimage/io/layered.py#L96)
 
 Save a layered image as .layered.
 
@@ -75,7 +89,7 @@ def saveLayer_LAYERED(fileName: str, layeredImage: LayeredImage) -> None: ...
 
 ## saveLayer_LAYEREDC
 
-[Show source in layered.py:138](../../../../layeredimage/io/layered.py#L138)
+[Show source in layered.py:136](../../../../layeredimage/io/layered.py#L136)
 
 Save a layeredc image as .layered.
 
@@ -89,7 +103,7 @@ def saveLayer_LAYEREDC(fileName: str, layeredImage: LayeredImage) -> None: ...
 
 ## writeImage_LAYERED
 
-[Show source in layered.py:121](../../../../layeredimage/io/layered.py#L121)
+[Show source in layered.py:119](../../../../layeredimage/io/layered.py#L119)
 
 Write an image to the archive.
 

documentation/reference/layeredimage/io/lsr.md

@@ -1,9 +1,6 @@
 # Lsr
 
-[Layeredimage Index](../../README.md#layeredimage-index) /
-[Layeredimage](../index.md#layeredimage) /
-[Io](./index.md#io) /
-Lsr
+[Layeredimage Index](../../README.md#layeredimage-index) / [Layeredimage](../index.md#layeredimage) / [Io](./index.md#io) / Lsr
 
 > Auto-generated documentation for [layeredimage.io.lsr](../../../../layeredimage/io/lsr.py) module.
 
@@ -13,7 +10,7 @@ Lsr
 
 ## openLayer_LSR
 
-[Show source in lsr.py:16](../../../../layeredimage/io/lsr.py#L16)
+[Show source in lsr.py:13](../../../../layeredimage/io/lsr.py#L13)
 
 Open a .lsr file into a layered image.
 
@@ -27,7 +24,7 @@ def openLayer_LSR(file: str) -> LayeredImage: ...
 
 ## saveLayer_LSR
 
-[Show source in lsr.py:37](../../../../layeredimage/io/lsr.py#L37)
+[Show source in lsr.py:34](../../../../layeredimage/io/lsr.py#L34)
 
 Save a layered image as .lsr.
 

documentation/reference/layeredimage/io/ora.md

@@ -1,9 +1,6 @@
 # Ora
 
-[Layeredimage Index](../../README.md#layeredimage-index) /
-[Layeredimage](../index.md#layeredimage) /
-[Io](./index.md#io) /
-Ora
+[Layeredimage Index](../../README.md#layeredimage-index) / [Layeredimage](../index.md#layeredimage) / [Io](./index.md#io) / Ora
 
 > Auto-generated documentation for [layeredimage.io.ora](../../../../layeredimage/io/ora.py) module.
 
@@ -14,7 +11,7 @@ Ora
 
 ## addLayer_ORA
 
-[Show source in ora.py:128](../../../../layeredimage/io/ora.py#L128)
+[Show source in ora.py:125](../../../../layeredimage/io/ora.py#L125)
 
 Update the project with a shiny new layer.
 
@@ -28,7 +25,7 @@ def addLayer_ORA(project, layer, blendLookup): ...
 
 ## openLayer_ORA
 
-[Show source in ora.py:14](../../../../layeredimage/io/ora.py#L14)
+[Show source in ora.py:11](../../../../layeredimage/io/ora.py#L11)
 
 Open an .ora file into a layered image.
 
@@ -42,7 +39,7 @@ def openLayer_ORA(file: str) -> LayeredImage: ...
 
 ## saveLayer_ORA
 
-[Show source in ora.py:84](../../../../layeredimage/io/ora.py#L84)
+[Show source in ora.py:81](../../../../layeredimage/io/ora.py#L81)
 
 Save a layered image as .ora.
 

documentation/reference/layeredimage/io/pdn.md

@@ -1,9 +1,6 @@
 # Pdn
 
-[Layeredimage Index](../../README.md#layeredimage-index) /
-[Layeredimage](../index.md#layeredimage) /
-[Io](./index.md#io) /
-Pdn
+[Layeredimage Index](../../README.md#layeredimage-index) / [Layeredimage](../index.md#layeredimage) / [Io](./index.md#io) / Pdn
 
 > Auto-generated documentation for [layeredimage.io.pdn](../../../../layeredimage/io/pdn.py) module.
 
@@ -13,7 +10,7 @@ Pdn
 
 ## openLayer_PDN
 
-[Show source in pdn.py:16](../../../../layeredimage/io/pdn.py#L16)
+[Show source in pdn.py:13](../../../../layeredimage/io/pdn.py#L13)
 
 Open a .pdn file into a layered image.
 
@@ -27,7 +24,7 @@ def openLayer_PDN(file: str) -> LayeredImage: ...
 
 ## saveLayer_PDN
 
-[Show source in pdn.py:55](../../../../layeredimage/io/pdn.py#L55)
+[Show source in pdn.py:52](../../../../layeredimage/io/pdn.py#L52)
 
 Save a layered image as .pdn.