2021.2.8

Author: FredHappyface

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+  - repo: https://github.com/FHPythonUtils/Blackt
+    rev: '2021'
+    hooks:
+      - id: blackt
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.9.3
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pycqa/pylint
+    rev: v2.11.1
+    hooks:
+      - id: pylint
+        args: [--disable=import-error,--jobs=0, --fail-under=9.8, --ignore-patterns=test.*?py]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.29.0
+    hooks:
+      - id: pyupgrade
+        args: [--py37-plus]

CHANGELOG.md

@@ -2,6 +2,11 @@
 All major and minor version changes will be documented in this file. Details of
 patch-level version changes can be found in [commit messages](../../commits/master).
 
+## 2021.2.8 - 2021/11/07
+
+- add pre-commit
+- code quality improvements
+
 ## 2021.2.7 - 2021/10/02
 
 - code quality improvements

DOCS/layeredimage/io/common.md

@@ -10,7 +10,7 @@ Do file io - Common Operations for file readers/writers.
 
 ## blendModeLookup
 
-[[find in source code]](../../../layeredimage/io/common.py#L13)
+[[find in source code]](../../../layeredimage/io/common.py#L14)
 
 ```python
 def blendModeLookup(
@@ -24,7 +24,7 @@ Get the blendmode from a lookup table.
 
 ## expandLayersToCanvas
 
-[[find in source code]](../../../layeredimage/io/common.py#L25)
+[[find in source code]](../../../layeredimage/io/common.py#L26)
 
 ```python
 def expandLayersToCanvas(

DOCS/layeredimage/io/lsr.md

@@ -10,7 +10,7 @@ Do file io - LSR.
 
 ## openLayer_LSR
 
-[[find in source code]](../../../layeredimage/io/lsr.py#L14)
+[[find in source code]](../../../layeredimage/io/lsr.py#L16)
 
 ```python
 def openLayer_LSR(file: str) -> LayeredImage:
@@ -20,7 +20,7 @@ Open a .lsr file into a layered image.
 
 ## saveLayer_LSR
 
-[[find in source code]](../../../layeredimage/io/lsr.py#L35)
+[[find in source code]](../../../layeredimage/io/lsr.py#L37)
 
 ```python
 def saveLayer_LSR(fileName: str, layeredImage: LayeredImage) -> None:

README.md

@@ -30,12 +30,16 @@ Use this module to read, and write to a number of layered image formats
 	- [Built for](#built-for)
 - [Install Python on Windows](#install-python-on-windows)
 	- [Chocolatey](#chocolatey)
-	- [Download](#download)
+	- [Windows - Python.org](#windows---pythonorg)
 - [Install Python on Linux](#install-python-on-linux)
 	- [Apt](#apt)
+	- [Dnf](#dnf)
+- [Install Python on MacOS](#install-python-on-macos)
+	- [Homebrew](#homebrew)
+	- [MacOS - Python.org](#macos---pythonorg)
 - [How to run](#how-to-run)
-	- [With VSCode](#with-vscode)
-	- [From the Terminal](#from-the-terminal)
+	- [Windows](#windows)
+	- [Linux/ MacOS](#linux-macos)
 - [Download Project](#download-project)
 	- [Clone](#clone)
 		- [Using The Command Line](#using-the-command-line)
@@ -228,44 +232,71 @@ pip install layeredimage
 Head to https://pypi.org/project/layeredimage/ for more info
 
 ## Language information
+
 ### Built for
-This program has been written for Python 3 and has been tested with
-Python version 3.9.0 <https://www.python.org/downloads/release/python-380/>.
+This program has been written for Python versions 3.7 - 3.10 and has been tested with both 3.7 and
+3.10
 
 ## Install Python on Windows
+
 ### Chocolatey
 
 ```powershell
 choco install python
 ```
 
-### Download
-To install Python, go to <https://www.python.org/> and download the latest
+### Windows - Python.org
+To install Python, go to https://www.python.org/downloads/windows/ and download the latest
 version.
 
 ## Install Python on Linux
+
 ### Apt
 
 ```bash
-sudo apt install python3.9
+sudo apt install python3.x
 ```
 
-## How to run
-### With VSCode
+### Dnf
+
+```bash
+sudo dnf install python3.x
+```
 
-1. Open the .py file in vscode
-2. Ensure a python 3.9 interpreter is selected (Ctrl+Shift+P > Python:Select
-Interpreter > Python 3.9)
-3. Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)
+## Install Python on MacOS
 
-### From the Terminal
+### Homebrew
 
 ```bash
-./[file].py
+brew install [email protected]
 ```
 
+### MacOS - Python.org
+To install Python, go to https://www.python.org/downloads/macos/ and download the latest
+version.
+
+## How to run
+
+### Windows
+
+- Module
+	`py -3.x -m [module]` or `[module]` (if module installs a script)
+
+- File
+	`py -3.x [file]` or `./[file]`
+
+### Linux/ MacOS
+
+- Module
+	`python3.x -m [module]` or `[module]` (if module installs a script)
+
+- File
+	`python3.x [file]` or `./[file]`
+
 ## Download Project
+
 ### Clone
+
 #### Using The Command Line
 
 1. Press the Clone or download button in the top right
@@ -279,7 +310,7 @@ clone to
 	```
 
 More information can be found at
-<https://help.github.com/en/articles/cloning-a-repository>
+https://help.github.com/en/articles/cloning-a-repository
 
 #### Using GitHub Desktop
 
@@ -288,7 +319,7 @@ More information can be found at
 3. Choose the path for where you want and click Clone
 
 More information can be found at
-<https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop>
+https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
 
 ### Download Zip File
 
@@ -297,6 +328,7 @@ More information can be found at
 3. Copy/ move to the desired location
 
 ## Community Files
+
 ### Licence
 MIT License
 Copyright (c) FredHappyface

layeredimage/io/common.py

@@ -3,11 +3,12 @@
 
 from typing import Any
 
+from blendmodes.imagetools import renderWAlphaOffset
 from metprint import FHFormatter, Logger, LogType
 from PIL.Image import Image
 
 from ..blend import BlendType
-from ..layeredimage import LayeredImage, renderWAlphaOffset
+from ..layeredimage import LayeredImage
 
 
 def blendModeLookup(

layeredimage/io/layered.py

@@ -114,8 +114,8 @@ def _saveLayer_LAYERED(fileName: str, layeredImage: LayeredImage, compressed: bo
 		thumbnail = compositeImage.copy()
 		thumbnail.thumbnail((256, 256))
 		imageLookup = {"composite": compositeImage, "thumbnail": thumbnail}
-		for image in imageLookup:
-			writeImage_LAYERED(imageLookup[image], layered, image + ".png", compressed)
+		for imageName, imageData in imageLookup.items():
+			writeImage_LAYERED(imageData, layered, imageName + ".png", compressed)
 
 
 def writeImage_LAYERED(image: Image.Image, zipFile: ZipFile, path: str, compressed: bool = False):

layeredimage/io/lsr.py

@@ -3,7 +3,9 @@
 
 from os import sep
 
-from ..layeredimage import LayeredImage, renderWAlphaOffset
+from blendmodes.imagetools import renderWAlphaOffset
+
+from ..layeredimage import LayeredImage
 from ..layergroup import Group, Layer
 
 # pylint: disable=invalid-name

layeredimage/layeredimage.py

@@ -38,8 +38,8 @@ def __init__(
 		if dimensions is None:
 			layerDimens = [layerOrGroup.dimensions for layerOrGroup in layersAndGroups]
 			self.dimensions = (
-				max([layerDimen[0] for layerDimen in layerDimens]),
-				max([layerDimen[1] for layerDimen in layerDimens]),
+				max(layerDimen[0] for layerDimen in layerDimens),
+				max(layerDimen[1] for layerDimen in layerDimens),
 			)
 		self.extras = kwargs
 

layeredimage/layergroup.py

@@ -168,8 +168,8 @@ def __init__(
 		if dimensions is None:
 			layerDimens = [layer.dimensions for layer in layers]
 			self.dimensions = (
-				max([dimensions[0] for dimensions in layerDimens]),
-				max([dimensions[1] for dimensions in layerDimens]),
+				max(dimensions[0] for dimensions in layerDimens),
+				max(dimensions[1] for dimensions in layerDimens),
 			)
 
 	def json(self) -> dict[str, Any]:

pyproject.toml

@@ -1,20 +1,16 @@
 [tool.poetry]
 name = "layeredimage"
-version = "2021.2.7"
+version = "2021.2.8"
+license = "mit"
 description = "Use this module to read, and write to a number of layered image formats"
 authors = ["FredHappyface"]
 classifiers = [
 	"Environment :: Console",
 	"Development Status :: 5 - Production/Stable",
 	"Intended Audience :: Developers",
 	"Intended Audience :: Education",
-	"License :: OSI Approved :: MIT License",
 	"Natural Language :: English",
 	"Operating System :: OS Independent",
-	"Programming Language :: Python :: 3",
-	"Programming Language :: Python :: 3.7",
-	"Programming Language :: Python :: 3.8",
-	"Programming Language :: Python :: 3.9",
 	"Programming Language :: Python :: Implementation :: CPython",
 	"Topic :: Multimedia :: Graphics",
 	"Topic :: Software Development :: Libraries :: Python Modules",
@@ -58,8 +54,9 @@ indent-string = "\t"
 ignore-patterns = "test_.*?py"
 
 [tool.pylint.messages_control]
-enable = ['F', 'E', 'W', 'R', 'C']
+enable = ["F", "E", "W", "R", "C"]
 disable = [
+	"not-callable", # Bug with 'LayeredImage is not callable (not-callable)'
 	"pointless-string-statement",
 	"superfluous-parens",
 	"bad-continuation",
@@ -72,6 +69,7 @@ target-version = ["py37"]
 
 [tool.isort]
 profile = "black"
+indent = "Tab"
 
 [tool.pydocstyle]
 convention = "google"