Skip to content

Commit 3700bf2

Browse files
FredHappyfaceFredHappyface
committed
feat: address more ruff findings
1 parent 9831d67 commit 3700bf2

27 files changed

+300
-205
lines changed

‎README.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ THISDIR = str(Path(__file__).resolve().parent)
149149
import layeredimage.io
150150

151151
# Do stuff
152-
ora = layeredimage.io.openLayerImage(THISDIR + "/image.ora")
152+
ora = layeredimage.io.openLayerImage(f"{THISDIR}/image.ora")
153153

154154
imageDimensions = ora.dimensions
155155
# There are a load of handy functions for getting layers, and adding new
@@ -161,10 +161,10 @@ layer.image = Image.new("RGBA", imageDimensions)
161161
ora.layersAndGroups[0] = layer
162162

163163
# And let's save
164-
layeredimage.io.saveLayerImage(THISDIR + "/image(modified).ora", ora)
164+
layeredimage.io.saveLayerImage(f"{THISDIR}/image(modified).ora", ora)
165165

166166
# Let's save a flattened version too
167-
ora.getFlattenLayers().save(THISDIR + "/image(modified).png")
167+
ora.getFlattenLayers().save(f"{THISDIR}/image(modified).png")
168168

169169
# Doing stuff with a group
170170
group = ora.getLayerOrGroup(1) # For the sake of the e.g. this is a group
@@ -192,34 +192,34 @@ sys.path.insert(0, os.path.dirname(THISDIR))
192192
import layeredimage.io
193193

194194
# ORA
195-
ora = layeredimage.io.openLayerImage(THISDIR + "/base24.ora")
196-
layeredimage.io.saveLayerImage(THISDIR + "/base24(ora).ora", ora)
197-
layeredimage.io.saveLayerImage(THISDIR + "/base24(ora).tiff", ora)
198-
ora.getFlattenLayers().save(THISDIR + "/base24(ora).png")
195+
ora = layeredimage.io.openLayerImage(f"{THISDIR}/base24.ora")
196+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(ora).ora", ora)
197+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(ora).tiff", ora)
198+
ora.getFlattenLayers().save(f"{THISDIR}/base24(ora).png")
199199

200200
# PSD
201-
psd = layeredimage.io.openLayerImage(THISDIR + "/base24.psd")
202-
layeredimage.io.saveLayerImage(THISDIR + "/base24(psd).ora", psd)
203-
layeredimage.io.saveLayerImage(THISDIR + "/base24(psd).tiff", psd)
204-
psd.getFlattenLayers().save(THISDIR + "/base24(psd).png")
201+
psd = layeredimage.io.openLayerImage(f"{THISDIR}/base24.psd")
202+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(psd).ora", psd)
203+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(psd).tiff", psd)
204+
psd.getFlattenLayers().save(f"{THISDIR}/base24(psd).png")
205205

206206
# PDN
207-
pdn = layeredimage.io.openLayerImage(THISDIR + "/base24.pdn")
208-
layeredimage.io.saveLayerImage(THISDIR + "/base24(pdn).ora", pdn)
209-
layeredimage.io.saveLayerImage(THISDIR + "/base24(pdn).tiff", pdn)
210-
pdn.getFlattenLayers().save(THISDIR + "/base24(pdn).png")
207+
pdn = layeredimage.io.openLayerImage(f"{THISDIR}/base24.pdn")
208+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(pdn).ora", pdn)
209+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(pdn).tiff", pdn)
210+
pdn.getFlattenLayers().save(f"{THISDIR}/base24(pdn).png")
211211

212212
# XCF
213-
xcf = layeredimage.io.openLayerImage(THISDIR + "/base24.xcf")
214-
layeredimage.io.saveLayerImage(THISDIR + "/base24(xcf).ora", xcf)
215-
layeredimage.io.saveLayerImage(THISDIR + "/base24(xcf).tiff", xcf)
216-
xcf.getFlattenLayers().save(THISDIR + "/base24(xcf).png")
213+
xcf = layeredimage.io.openLayerImage(f"{THISDIR}/base24.xcf")
214+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(xcf).ora", xcf)
215+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(xcf).tiff", xcf)
216+
xcf.getFlattenLayers().save(f"{THISDIR}/base24(xcf).png")
217217

218218
# TIFF
219-
tiff = layeredimage.io.openLayerImage(THISDIR + "/base24.tiff")
220-
layeredimage.io.saveLayerImage(THISDIR + "/base24(tiff).ora", tiff)
221-
layeredimage.io.saveLayerImage(THISDIR + "/base24(tiff).tiff", tiff)
222-
tiff.getFlattenLayers().save(THISDIR + "/base24(tiff).png")
219+
tiff = layeredimage.io.openLayerImage(f"{THISDIR}/base24.tiff")
220+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(tiff).ora", tiff)
221+
layeredimage.io.saveLayerImage(f"{THISDIR}/base24(tiff).tiff", tiff)
222+
tiff.getFlattenLayers().save(f"{THISDIR}/base24(tiff).png")
223223
```
224224

225225
## Documentation

‎convert.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
files = [THISDIR / file for file in listdir(THISDIR) if (THISDIR / file).is_file()]
1414
for file in files:
1515
with contextlib.suppress(ValueError):
16-
layeredimage.io.saveLayerImage(file + ".ora", layeredimage.io.openLayerImage(file))
16+
layeredimage.io.saveLayerImage(f"{file}.ora", layeredimage.io.openLayerImage(file))

‎documentation/reference/layeredimage/io/common.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## blendModeLookup
1212

13-
[Show source in common.py:13](../../../../layeredimage/io/common.py#L13)
13+
[Show source in common.py:14](../../../../layeredimage/io/common.py#L14)
1414

1515
Get the blendmode from a lookup table.
1616

@@ -26,7 +26,7 @@ def blendModeLookup(
2626

2727
## expandLayersToCanvas
2828

29-
[Show source in common.py:23](../../../../layeredimage/io/common.py#L23)
29+
[Show source in common.py:24](../../../../layeredimage/io/common.py#L24)
3030

3131
Return layers and throw a warning if the image has groups.
3232

@@ -36,4 +36,8 @@ Return layers and throw a warning if the image has groups.
3636
def expandLayersToCanvas(
3737
layeredImage: LayeredImage, imageFormat: str
3838
) -> list[Image]: ...
39-
```
39+
```
40+
41+
#### See also
42+
43+
- [LayeredImage](../layeredimage.md#layeredimage)

‎documentation/reference/layeredimage/io/gif.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## openLayer_GIF
1212

13-
[Show source in gif.py:12](../../../../layeredimage/io/gif.py#L12)
13+
[Show source in gif.py:13](../../../../layeredimage/io/gif.py#L13)
1414

1515
Open a .gif file into a layered image.
1616

@@ -20,16 +20,24 @@ Open a .gif file into a layered image.
2020
def openLayer_GIF(file: str) -> LayeredImage: ...
2121
```
2222

23+
#### See also
24+
25+
- [LayeredImage](../layeredimage.md#layeredimage)
26+
2327

2428

2529
## saveLayer_GIF
2630

27-
[Show source in gif.py:30](../../../../layeredimage/io/gif.py#L30)
31+
[Show source in gif.py:31](../../../../layeredimage/io/gif.py#L31)
2832

2933
Save a layered image as .gif.
3034

3135
#### Signature
3236

3337
```python
3438
def saveLayer_GIF(fileName: str, layeredImage: LayeredImage) -> None: ...
35-
```
39+
```
40+
41+
#### See also
42+
43+
- [LayeredImage](../layeredimage.md#layeredimage)

‎documentation/reference/layeredimage/io/index.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
## exportFlatImage
1515

16-
[Show source in __init__.py:109](../../../../layeredimage/io/__init__.py#L109)
16+
[Show source in __init__.py:111](../../../../layeredimage/io/__init__.py#L111)
1717

1818
Export the layered image to a unilayer image file.
1919

@@ -23,25 +23,29 @@ Export the layered image to a unilayer image file.
2323
def exportFlatImage(fileName: str, layeredImage: LayeredImage) -> None: ...
2424
```
2525

26+
#### See also
27+
28+
- [LayeredImage](../layeredimage.md#layeredimage)
29+
2630

2731

2832
## extNotRecognised
2933

30-
[Show source in __init__.py:24](../../../../layeredimage/io/__init__.py#L24)
34+
[Show source in __init__.py:26](../../../../layeredimage/io/__init__.py#L26)
3135

3236
Output the file extension not recognised error.
3337

3438
#### Signature
3539

3640
```python
37-
def extNotRecognised(fileName: str): ...
41+
def extNotRecognised(fileName: str) -> None: ...
3842
```
3943

4044

4145

4246
## openLayerImage
4347

44-
[Show source in __init__.py:34](../../../../layeredimage/io/__init__.py#L34)
48+
[Show source in __init__.py:35](../../../../layeredimage/io/__init__.py#L35)
4549

4650
Open a layer image file into a layer image object.
4751

@@ -67,11 +71,15 @@ Open a layer image file into a layer image object.
6771
def openLayerImage(file: str | Path) -> LayeredImage: ...
6872
```
6973

74+
#### See also
75+
76+
- [LayeredImage](../layeredimage.md#layeredimage)
77+
7078

7179

7280
## saveLayerImage
7381

74-
[Show source in __init__.py:73](../../../../layeredimage/io/__init__.py#L73)
82+
[Show source in __init__.py:75](../../../../layeredimage/io/__init__.py#L75)
7583

7684
Save a layered image to a file.
7785

@@ -97,6 +105,10 @@ Save a layered image to a file.
97105
def saveLayerImage(fileName: str | Path, layeredImage: LayeredImage) -> None: ...
98106
```
99107

108+
#### See also
109+
110+
- [LayeredImage](../layeredimage.md#layeredimage)
111+
100112

101113

102114
## Modules

‎documentation/reference/layeredimage/io/layered.md

+33-9
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
## _saveLayer_LAYERED
1717

18-
[Show source in layered.py:101](../../../../layeredimage/io/layered.py#L101)
18+
[Show source in layered.py:104](../../../../layeredimage/io/layered.py#L104)
1919

2020
Save a layered image as .layered.
2121

@@ -27,11 +27,15 @@ def _saveLayer_LAYERED(
2727
) -> None: ...
2828
```
2929

30+
#### See also
31+
32+
- [LayeredImage](../layeredimage.md#layeredimage)
33+
3034

3135

3236
## grabLayer_LAYERED
3337

34-
[Show source in layered.py:81](../../../../layeredimage/io/layered.py#L81)
38+
[Show source in layered.py:82](../../../../layeredimage/io/layered.py#L82)
3539

3640
Grab an image from .layered.
3741

@@ -40,14 +44,18 @@ Grab an image from .layered.
4044
```python
4145
def grabLayer_LAYERED(
4246
zipFile: ZipFile, layer: dict[str, Any], blendLookup: dict[str, Any]
43-
): ...
47+
) -> Layer: ...
4448
```
4549

50+
#### See also
51+
52+
- [Layer](../layergroup.md#layer)
53+
4654

4755

4856
## openLayer_LAYERED
4957

50-
[Show source in layered.py:19](../../../../layeredimage/io/layered.py#L19)
58+
[Show source in layered.py:20](../../../../layeredimage/io/layered.py#L20)
5159

5260
Open a .layered file into a layered image.
5361

@@ -57,11 +65,15 @@ Open a .layered file into a layered image.
5765
def openLayer_LAYERED(file: str) -> LayeredImage: ...
5866
```
5967

68+
#### See also
69+
70+
- [LayeredImage](../layeredimage.md#layeredimage)
71+
6072

6173

6274
## openLayer_LAYEREDC
6375

64-
[Show source in layered.py:131](../../../../layeredimage/io/layered.py#L131)
76+
[Show source in layered.py:141](../../../../layeredimage/io/layered.py#L141)
6577

6678
Open a .layeredc file into a layered image.
6779

@@ -71,11 +83,15 @@ Open a .layeredc file into a layered image.
7183
def openLayer_LAYEREDC(file: str) -> LayeredImage: ...
7284
```
7385

86+
#### See also
87+
88+
- [LayeredImage](../layeredimage.md#layeredimage)
89+
7490

7591

7692
## saveLayer_LAYERED
7793

78-
[Show source in layered.py:96](../../../../layeredimage/io/layered.py#L96)
94+
[Show source in layered.py:99](../../../../layeredimage/io/layered.py#L99)
7995

8096
Save a layered image as .layered.
8197

@@ -85,11 +101,15 @@ Save a layered image as .layered.
85101
def saveLayer_LAYERED(fileName: str, layeredImage: LayeredImage) -> None: ...
86102
```
87103

104+
#### See also
105+
106+
- [LayeredImage](../layeredimage.md#layeredimage)
107+
88108

89109

90110
## saveLayer_LAYEREDC
91111

92-
[Show source in layered.py:136](../../../../layeredimage/io/layered.py#L136)
112+
[Show source in layered.py:146](../../../../layeredimage/io/layered.py#L146)
93113

94114
Save a layeredc image as .layered.
95115

@@ -99,11 +119,15 @@ Save a layeredc image as .layered.
99119
def saveLayer_LAYEREDC(fileName: str, layeredImage: LayeredImage) -> None: ...
100120
```
101121

122+
#### See also
123+
124+
- [LayeredImage](../layeredimage.md#layeredimage)
125+
102126

103127

104128
## writeImage_LAYERED
105129

106-
[Show source in layered.py:119](../../../../layeredimage/io/layered.py#L119)
130+
[Show source in layered.py:126](../../../../layeredimage/io/layered.py#L126)
107131

108132
Write an image to the archive.
109133

@@ -112,5 +136,5 @@ Write an image to the archive.
112136
```python
113137
def writeImage_LAYERED(
114138
image: Image.Image, zipFile: ZipFile, path: str, compressed: bool = False
115-
): ...
139+
) -> None: ...
116140
```

‎documentation/reference/layeredimage/io/lsr.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,24 @@ Open a .lsr file into a layered image.
2020
def openLayer_LSR(file: str) -> LayeredImage: ...
2121
```
2222

23+
#### See also
24+
25+
- [LayeredImage](../layeredimage.md#layeredimage)
26+
2327

2428

2529
## saveLayer_LSR
2630

27-
[Show source in lsr.py:34](../../../../layeredimage/io/lsr.py#L34)
31+
[Show source in lsr.py:38](../../../../layeredimage/io/lsr.py#L38)
2832

2933
Save a layered image as .lsr.
3034

3135
#### Signature
3236

3337
```python
3438
def saveLayer_LSR(fileName: str, layeredImage: LayeredImage) -> None: ...
35-
```
39+
```
40+
41+
#### See also
42+
43+
- [LayeredImage](../layeredimage.md#layeredimage)

0 commit comments

Comments
 (0)