feat(workflow): workflow with pyright and flake8

Author: danila-schelkov

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v2
+      with:
+        python-version: "3.10"
+  
+    - name: Install requirements
+      run: |
+        pip install pipx
+        pipx install cookiecutter
+        pipx runpip cookiecutter install -r requirements.txt
+        pipx install flake8
+        pipx install pyright
+
+    - name: Linting code by flake8
+      run: |
+        python -m flake8 --show-source --statistics
+        
+    - name: Check types by pyright
+      run: |
+        python -m pyright

system/bytestream.py

@@ -1,10 +1,12 @@
 import io
-from typing import Literal
+from typing import Literal, Optional, Union
 
 
 class Reader(io.BytesIO):
     def __init__(
-        self, buffer: bytes = b"", endian: Literal["little", "big"] = "little"
+        self,
+        buffer: bytes = b"",
+        endian: Union[Literal["little"], Literal["big"]] = "little",
     ):
         super().__init__(buffer)
 
@@ -68,7 +70,7 @@ def write_uint32(self, integer: int):
     def write_int32(self, integer: int):
         self.write_int(integer, 4, True)
 
-    def write_string(self, string: str = None):
+    def write_string(self, string: Optional["str"] = None):
         if string is None:
             self.write_byte(255)
             return

system/lib/features/cut_sprites.py

@@ -11,25 +11,26 @@ def cut_sprites(swf: SupercellSWF, export_folder: str):
     os.makedirs(f"{export_folder}/movie_clips", exist_ok=True)
 
     # TODO: Too slow, fix it
-    # movie_clips_skipped = 0
-    # movie_clip_count = len(swf.movie_clips)
-    # for movie_clip_index in range(movie_clip_count):
-    #     movie_clip = swf.movie_clips[movie_clip_index]
-    #
-    #     rendered_movie_clip = movie_clip.render(swf)
-    #     if sum(rendered_movie_clip.size) >= 2:
-    #         rendered_movie_clip.save(f'{export_folder}/movie_clips/{movie_clip.export_name or movie_clip.id}.png')
-    #     else:
-    #         # For debug:
-    #         # logger.warning(f'MovieClip {movie_clip.id} cannot be rendered.')
-    #         movie_clips_skipped += 1
-    #
-    #     Console.progress_bar(
-    #         'Rendering movie clips (%d/%d). Skipped count: %d' %
-    #         (movie_clip_index + 1, movie_clip_count, movie_clips_skipped),
-    #         movie_clip_index,
-    #         movie_clip_count
-    #     )
+    movie_clips_skipped = 0
+    movie_clip_count = len(swf.movie_clips)
+    for movie_clip_index in range(movie_clip_count):
+        movie_clip = swf.movie_clips[movie_clip_index]
+
+        rendered_movie_clip = movie_clip.render(swf)
+        if sum(rendered_movie_clip.size) >= 2:
+            clip_name = movie_clip.export_name or movie_clip.id
+            rendered_movie_clip.save(f"{export_folder}/movie_clips/{clip_name}.png")
+        else:
+            # For debug:
+            # logger.warning(f'MovieClip {movie_clip.id} cannot be rendered.')
+            movie_clips_skipped += 1
+
+        Console.progress_bar(
+            "Rendering movie clips (%d/%d). Skipped count: %d"
+            % (movie_clip_index + 1, movie_clip_count, movie_clips_skipped),
+            movie_clip_index,
+            movie_clip_count,
+        )
 
     shapes_count = len(swf.shapes)
     swf.xcod_writer.write_uint16(shapes_count)

system/lib/features/place_sprites.py

@@ -1,17 +1,18 @@
 import os
+from typing import List, Tuple
 
 from PIL import Image, ImageDraw
 
 from system.lib import Console
 from system.lib.helper import get_sides, get_size
 from system.lib.images import get_format_by_pixel_type
-from system.lib.xcod import parse_info, FileInfo
+from system.lib.xcod import FileInfo, parse_info
 from system.localization import locale
 
 
 def place_sprites(
     xcod_path: str, folder: str, overwrite: bool = False
-) -> (list, FileInfo):
+) -> Tuple[List[Image.Image], FileInfo]:
     file_info, xcod = parse_info(xcod_path)
 
     files_to_overwrite = os.listdir(f'{folder}{"/overwrite" if overwrite else ""}')
@@ -83,7 +84,7 @@ def place_sprites(
 
             width, height = get_size(left, top, right, bottom)
 
-            bbox = left, top, right, bottom
+            bbox = int(left), int(top), int(right), int(bottom)
 
             tmp_region = Image.open(
                 f'{folder}{"/overwrite" if overwrite else ""}/{filename}'

system/lib/features/sc/__init__.py

@@ -1,19 +1,23 @@
 import os
 import struct
+from typing import List, Optional
 
-from PIL import Image
 from loguru import logger
+from PIL import Image
 
 from system.bytestream import Writer
 from system.lib.console import Console
 from system.lib.features.files import write_sc
-from system.lib.images import get_pixel_size, split_image, save_texture
+from system.lib.images import get_pixel_size, save_texture, split_image
 from system.lib.xcod import FileInfo
 from system.localization import locale
 
 
 def compile_sc(
-    _dir, file_info: FileInfo, sheets: list = None, output_folder: str = None
+    _dir,
+    file_info: FileInfo,
+    sheets: Optional[List[Image.Image]] = None,
+    output_folder: Optional[str] = None,
 ):
     name = _dir.split("/")[-2]
 

system/lib/helper.py

@@ -1,9 +1,9 @@
-from typing import List, Tuple
+from typing import List, Tuple, Union
 
 from system.lib.objects.point import Point
 
 
-def get_size(left: float, top: float, right: float, bottom: float) -> (int, int):
+def get_size(left: float, top: float, right: float, bottom: float) -> Tuple[int, int]:
     """Returns width and height of given rect.
 
     :param left: left side of polygon
@@ -16,13 +16,14 @@ def get_size(left: float, top: float, right: float, bottom: float) -> (int, int)
 
 
 def get_sides(
-    points: List[Tuple[float, float]] or List[Point]
-) -> (float, float, float, float):
+    points: Union[List[Tuple[float, float]], List[Tuple[int, int]], List[Point]]
+) -> Tuple[float, float, float, float]:
     """Calculates and returns rect sides.
 
     :param points: polygon points
     :return: left, top, right, bottom
     """
+
     if len(points) > 0:
         point = points[0]
         if isinstance(point, Point):

system/lib/images.py

@@ -1,6 +1,7 @@
 import math
 import struct
 
+import PIL.PyAccess
 from PIL import Image
 
 from system.bytestream import Reader
@@ -10,9 +11,10 @@
 CHUNK_SIZE = 32
 
 
-def load_image_from_buffer(img: Image) -> None:
+def load_image_from_buffer(img: Image.Image) -> None:
     width, height = img.size
-    img_loaded = img.load()
+    # noinspection PyTypeChecker
+    img_loaded: PIL.PyAccess.PyAccess = img.load()
 
     with open("pixel_buffer", "rb") as pixel_buffer:
         channels_count = int.from_bytes(pixel_buffer.read(1), "little")
@@ -22,12 +24,13 @@ def load_image_from_buffer(img: Image) -> None:
                 img_loaded[x, y] = tuple(pixel_buffer.read(channels_count))
 
 
-def join_image(img: Image) -> None:
+def join_image(img: Image.Image) -> None:
     with open("pixel_buffer", "rb") as pixel_buffer:
         channels_count = int.from_bytes(pixel_buffer.read(1), "little")
 
         width, height = img.size
-        loaded_img = img.load()
+        # noinspection PyTypeChecker
+        loaded_img: PIL.PyAccess.PyAccess = img.load()
 
         x_chunks_count = width // CHUNK_SIZE
         y_chunks_count = height // CHUNK_SIZE
@@ -51,13 +54,15 @@ def join_image(img: Image) -> None:
             Console.progress_bar(locale.join_pic, y_chunk, y_chunks_count + 1)
 
 
-def split_image(img: Image):
+def split_image(img: Image.Image):
     def add_pixel(pixel: tuple):
         loaded_image[pixel_index % width, int(pixel_index / width)] = pixel
 
     width, height = img.size
-    loaded_image = img.load()
-    loaded_clone = img.copy().load()
+    # noinspection PyTypeChecker
+    loaded_image: PIL.PyAccess.PyAccess = img.load()
+    # noinspection PyTypeChecker
+    loaded_clone: PIL.PyAccess.PyAccess = img.copy().load()
 
     x_chunks_count = width // CHUNK_SIZE
     y_chunks_count = height // CHUNK_SIZE
@@ -180,53 +185,54 @@ def read_pixel():
 
 
 def save_texture(sc, img, _type):
-    write_pixel = None
     if _type in (0, 1):
 
         def write_pixel(pixel):
             return struct.pack("4B", *pixel)
 
-    if _type == 2:
+    elif _type == 2:
 
         def write_pixel(pixel):
             r, g, b, a = pixel
             return struct.pack("<H", a >> 4 | b >> 4 << 4 | g >> 4 << 8 | r >> 4 << 12)
 
-    if _type == 3:
+    elif _type == 3:
 
         def write_pixel(pixel):
             r, g, b, a = pixel
             return struct.pack("<H", a >> 7 | b >> 3 << 1 | g >> 3 << 6 | r >> 3 << 11)
 
-    if _type == 4:
+    elif _type == 4:
 
         def write_pixel(pixel):
             r, g, b = pixel
             return struct.pack("<H", b >> 3 | g >> 2 << 5 | r >> 3 << 11)
 
-    if _type == 6:
+    elif _type == 6:
 
         def write_pixel(pixel):
             return struct.pack("2B", *pixel[::-1])
 
-    if _type == 10:
+    elif _type == 10:
 
         def write_pixel(pixel):
             return struct.pack("B", pixel)
 
-    if write_pixel is not None:
-        width, height = img.size
+    else:
+        return
 
-        pix = img.getdata()
-        point = -1
-        for y in range(height):
-            for x in range(width):
-                sc.write(write_pixel(pix[y * width + x]))
+    width, height = img.size
 
-            curr = Console.percent(y, height)
-            if curr > point:
-                Console.progress_bar(locale.writing_pic, y, height)
-                point = curr
+    pix = img.getdata()
+    point = -1
+    for y in range(height):
+        for x in range(width):
+            sc.write(write_pixel(pix[y * width + x]))
+
+        curr = Console.percent(y, height)
+        if curr > point:
+            Console.progress_bar(locale.writing_pic, y, height)
+            point = curr
 
 
 def transform_image(image, scale_x, scale_y, angle, x, y):

system/lib/objects/__init__.py

@@ -1,3 +1,5 @@
-from system.lib.objects.shape import Shape
 from system.lib.objects.movie_clip import MovieClip
+from system.lib.objects.shape import Shape
 from system.lib.objects.texture import SWFTexture
+
+__all__ = ["Shape", "MovieClip", "SWFTexture"]

system/lib/objects/movie_clip.py

@@ -1,5 +1,5 @@
 from math import ceil
-from typing import List, Tuple
+from typing import List, Optional, Tuple
 
 from PIL import Image
 
@@ -12,7 +12,7 @@
 class MovieClipFrame:
     def __init__(self):
         self._elements_count: int = 0
-        self._label: str or None = None
+        self._label: Optional[str] = None
 
         self._elements: List[Tuple[int, int, int]] = []
 
@@ -29,7 +29,7 @@ def set_elements(self, elements: List[Tuple[int, int, int]]) -> None:
     def get_elements(self) -> List[Tuple[int, int, int]]:
         return self._elements
 
-    def get_element(self, index: int) -> (int, int, int):
+    def get_element(self, index: int) -> Tuple[int, int, int]:
         return self._elements[index]
 
 
@@ -38,7 +38,7 @@ def __init__(self):
         super().__init__()
 
         self.id = -1
-        self.export_name: str or None = None
+        self.export_name: Optional[str] = None
         self.fps: int = 30
         self.frames_count: int = 0
         self.frames: List[MovieClipFrame] = []
@@ -47,8 +47,6 @@ def __init__(self):
         self.binds: List[int] = []
         self.matrix_bank_index: int = 0
 
-        self.points = []
-
     def load(self, swf, tag: int):
         self.id = swf.reader.read_ushort()
 
@@ -108,7 +106,7 @@ def load(self, swf, tag: int):
             else:
                 swf.reader.read(frame_length)
 
-    def render(self, swf, matrix=None) -> Image:
+    def render(self, swf, matrix=None) -> Image.Image:
         matrix_bank: MatrixBank = swf.get_matrix_bank(self.matrix_bank_index)
 
         # TODO: make it faster

system/lib/objects/point.py

@@ -1,3 +1,6 @@
+from typing import Tuple
+
+
 class Point:
     def __init__(self, x: float = 0, y: float = 0):
         self.x: float = x
@@ -26,10 +29,10 @@ def __repr__(self):
         return str(self.position)
 
     @property
-    def position(self) -> (float, float):
+    def position(self) -> Tuple[float, float]:
         return self.x, self.y
 
     @position.setter
-    def position(self, value: (float, float)):
+    def position(self, value: Tuple[float, float]):
         self.x = value[0]
         self.y = value[1]