typehints

Author: JaskRendix

apps/demo/demo-stitched.py

@@ -24,7 +24,7 @@
     VIDEORESIZE,
     K_r,
 )
-from pytmx.util_pygame import load_pygame
+from pytmx.util_pygame import load_pygame  # type: ignore
 
 import pyscroll
 from pyscroll.data import MapAggregator, TiledMapData
@@ -52,7 +52,7 @@ def __init__(self) -> None:
         self.velocity = [0, 0]
         self._position = [0.0, 0.0]
         self._old_position = self.position
-        self.rect = self.image.get_rect()
+        self.rect: pygame.Rect = self.image.get_rect()
         self.feet = pygame.Rect(0, 0, self.rect.width * 0.5, 8)
 
     @property
@@ -67,12 +67,12 @@ def update(self, dt: float) -> None:
         self._old_position = self._position[:]
         self._position[0] += self.velocity[0] * dt
         self._position[1] += self.velocity[1] * dt
-        self.rect.topleft = self._position
+        self.rect.topleft = (int(self._position[0]), int(self._position[1]))
         self.feet.midbottom = self.rect.midbottom
 
     def move_back(self, dt: float) -> None:
         self._position = self._old_position
-        self.rect.topleft = self._position
+        self.rect.topleft = (int(self._position[0]), int(self._position[1]))
         self.feet.midbottom = self.rect.midbottom
 
 
@@ -99,7 +99,7 @@ def __init__(self, screen: pygame.Surface) -> None:
             pyscroll_data = TiledMapData(tmx_data)
             world_data.add_map(pyscroll_data, offset)
 
-        self.map_layer = pyscroll.BufferedRenderer(
+        self.map_layer = pyscroll.orthographic.BufferedRenderer(
             data=world_data,
             size=screen.get_size(),
             clamp_camera=True,
@@ -110,7 +110,7 @@ def __init__(self, screen: pygame.Surface) -> None:
         # put the hero in the center of the map
         self.hero = Hero()
         self.hero.layer = 0
-        self.hero.position = (400, 400)
+        self.hero.position = [400.0, 400.0]
 
         # add our hero to the group
         self.group.add(self.hero)

apps/demo/demo.py

@@ -12,10 +12,11 @@
 """
 import collections
 import logging
+from typing import Deque
 
 import pygame
 from pygame.locals import *
-from pytmx.util_pygame import load_pygame
+from pytmx.util_pygame import load_pygame  # type: ignore
 
 import pyscroll
 import pyscroll.data
@@ -31,7 +32,7 @@
 
 
 # simple wrapper to keep the screen resizeable
-def init_screen(width, height):
+def init_screen(width: int, height: int) -> pygame.Surface:
     return pygame.display.set_mode((width, height), pygame.RESIZABLE)
 
 
@@ -42,7 +43,7 @@ class ScrollTest:
 
     """
 
-    def __init__(self, filename) -> None:
+    def __init__(self, filename: str) -> None:
 
         # load data from pytmx
         tmx_data = load_pygame(filename)
@@ -60,7 +61,7 @@ def __init__(self, filename) -> None:
         t = ["scroll demo. press escape to quit", "arrow keys move"]
 
         # save the rendered text
-        self.text_overlay = [f.render(i, 1, (180, 180, 0)) for i in t]
+        self.text_overlay = [f.render(i, True, (180, 180, 0)) for i in t]
 
         # set our initial viewpoint in the center of the map
         self.center = [
@@ -71,12 +72,12 @@ def __init__(self, filename) -> None:
         # the camera vector is used to handle camera movement
         self.camera_acc = [0, 0, 0]
         self.camera_vel = [0, 0, 0]
-        self.last_update_time = 0
+        self.last_update_time = 0.0
 
         # true when running
         self.running = False
 
-    def draw(self, surface) -> None:
+    def draw(self, surface: pygame.Surface) -> None:
 
         # tell the map_layer (BufferedRenderer) to draw to the surface
         # the draw function requires a rect to draw to.
@@ -85,7 +86,7 @@ def draw(self, surface) -> None:
         # blit our text over the map
         self.draw_text(surface)
 
-    def draw_text(self, surface) -> None:
+    def draw_text(self, surface: pygame.Surface) -> None:
         y = 0
         for text in self.text_overlay:
             surface.blit(text, (0, y))
@@ -116,27 +117,27 @@ def handle_input(self) -> None:
         # but is much easier to use.
         pressed = pygame.key.get_pressed()
         if pressed[K_UP]:
-            self.camera_acc[1] = -SCROLL_SPEED * self.last_update_time
+            self.camera_acc[1] = int(-SCROLL_SPEED * self.last_update_time)
         elif pressed[K_DOWN]:
-            self.camera_acc[1] = SCROLL_SPEED * self.last_update_time
+            self.camera_acc[1] = int(SCROLL_SPEED * self.last_update_time)
         else:
             self.camera_acc[1] = 0
 
         if pressed[K_LEFT]:
-            self.camera_acc[0] = -SCROLL_SPEED * self.last_update_time
+            self.camera_acc[0] = int(-SCROLL_SPEED * self.last_update_time)
         elif pressed[K_RIGHT]:
-            self.camera_acc[0] = SCROLL_SPEED * self.last_update_time
+            self.camera_acc[0] = int(SCROLL_SPEED * self.last_update_time)
         else:
             self.camera_acc[0] = 0
 
-    def update(self, td) -> None:
+    def update(self, td: float) -> None:
         self.last_update_time = td
 
         friction = pow(0.0001, self.last_update_time)
 
         # update the camera vector
-        self.camera_vel[0] += self.camera_acc[0] * td
-        self.camera_vel[1] += self.camera_acc[1] * td
+        self.camera_vel[0] += int(self.camera_acc[0] * td)
+        self.camera_vel[1] += int(self.camera_acc[1] * td)
 
         self.camera_vel[0] *= friction
         self.camera_vel[1] *= friction
@@ -165,13 +166,13 @@ def update(self, td) -> None:
 
         # set the center somewhere else
         # in a game, you would set center to a playable character
-        self.map_layer.center(self.center)
+        self.map_layer.center((self.center[0], self.center[1]))
 
     def run(self) -> None:
         clock = pygame.time.Clock()
         self.running = True
         fps = 60.0
-        fps_log = collections.deque(maxlen=20)
+        fps_log: Deque[float] = collections.deque(maxlen=20)
 
         try:
             while self.running:

apps/tutorial/quest.py

@@ -26,7 +26,7 @@
     VIDEORESIZE,
     K_r,
 )
-from pytmx.util_pygame import load_pygame
+from pytmx.util_pygame import load_pygame  # type: ignore
 
 import pyscroll
 import pyscroll.data
@@ -76,7 +76,7 @@ def __init__(self) -> None:
         self.velocity = [0, 0]
         self._position = [0.0, 0.0]
         self._old_position = self.position
-        self.rect = self.image.get_rect()
+        self.rect: pygame.Rect = self.image.get_rect()
         self.feet = pygame.Rect(0, 0, self.rect.width * 0.5, 8)
 
     @property
@@ -91,7 +91,7 @@ def update(self, dt: float) -> None:
         self._old_position = self._position[:]
         self._position[0] += self.velocity[0] * dt
         self._position[1] += self.velocity[1] * dt
-        self.rect.topleft = self._position
+        self.rect.topleft = (int(self._position[0]), int(self._position[1]))
         self.feet.midbottom = self.rect.midbottom
 
     def move_back(self, dt: float) -> None:
@@ -100,7 +100,7 @@ def move_back(self, dt: float) -> None:
 
         """
         self._position = self._old_position
-        self.rect.topleft = self._position
+        self.rect.topleft = (int(self._position[0]), int(self._position[1]))
         self.feet.midbottom = self.rect.midbottom
 
 
@@ -131,7 +131,7 @@ def __init__(self, screen: pygame.Surface) -> None:
             self.walls.append(pygame.Rect(obj.x, obj.y, obj.width, obj.height))
 
         # create new renderer (camera)
-        self.map_layer = pyscroll.BufferedRenderer(
+        self.map_layer = pyscroll.orthographic.BufferedRenderer(
             data=pyscroll.data.TiledMapData(tmx_data),
             size=screen.get_size(),
             clamp_camera=False,
@@ -147,7 +147,8 @@ def __init__(self, screen: pygame.Surface) -> None:
 
         # put the hero in the center of the map
         self.hero = Hero()
-        self.hero.position = self.map_layer.map_rect.center
+        _center = self.map_layer.map_rect.center
+        self.hero.position = [float(i) for i in _center]
 
         # add our hero to the group
         self.group.add(self.hero)

pyscroll/data.py

@@ -7,6 +7,7 @@
 from __future__ import annotations
 
 import time
+from collections.abc import Iterable
 from heapq import heappop, heappush
 from itertools import product
 
@@ -43,8 +44,10 @@ class PyscrollDataAdapter:
     # or properties.  they are listed here as class
     # instances, but use as properties is fine, too.
 
-    tile_size = None  # (int, int): size of each tile in pixels
-    map_size = None  # (int, int): size of map in tiles
+    # (int, int): size of each tile in pixels
+    tile_size: tuple[int, int] = (0, 0)
+    # (int, int): size of map in tiles
+    map_size: tuple[int, int] = (0, 0)
     visible_tile_layers = None  # list of visible layer integers
 
     def __init__(self) -> None:
@@ -289,7 +292,7 @@ class TiledMapData(PyscrollDataAdapter):
 
     """
 
-    def __init__(self, tmx) -> None:
+    def __init__(self, tmx: pytmx.TiledMap) -> None:
         super(TiledMapData, self).__init__()
         self.tmx = tmx
         self.reload_animations()
@@ -320,19 +323,19 @@ def convert_surfaces(self, parent: Surface, alpha: bool = False) -> None:
         self.tmx.images = images
 
     @property
-    def tile_size(self):
+    def tile_size(self) -> tuple[int, int]:
         return self.tmx.tilewidth, self.tmx.tileheight
 
     @property
-    def map_size(self):
+    def map_size(self) -> tuple[int, int]:
         return self.tmx.width, self.tmx.height
 
     @property
     def visible_tile_layers(self):
         return self.tmx.visible_tile_layers
 
     @property
-    def visible_object_layers(self):
+    def visible_object_layers(self) -> Iterable[pytmx.TiledObjectGroup]:
         return (
             layer
             for layer in self.tmx.visible_layers
@@ -349,10 +352,10 @@ def _get_tile_image_by_id(self, id) -> Surface:
         return self.tmx.images[id]
 
     def get_tile_images_by_rect(self, rect: RectLike):
-        def rev(seq, start, stop):
+        def rev(seq:list[int], start:int, stop: int) -> enumerate[int]:
             if start < 0:
                 start = 0
-            return enumerate(seq[start : stop + 1], start)
+            return enumerate(seq[start:stop + 1], start)
 
         x1, y1, x2, y2 = rect_to_bb(rect)
         images = self.tmx.images

pyscroll/group.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 import pygame
 
@@ -17,7 +17,7 @@ class PyscrollGroup(pygame.sprite.LayeredUpdates):
 
     """
 
-    def __init__(self, map_layer: BufferedRenderer, *args, **kwargs) -> None:
+    def __init__(self, map_layer: BufferedRenderer, *args: Any, **kwargs: Any) -> None:
         pygame.sprite.LayeredUpdates.__init__(self, *args, **kwargs)
         self._map_layer = map_layer
 

pyscroll/orthographic.py

@@ -40,7 +40,7 @@ def __init__(
         clamp_camera: bool = True,
         colorkey=None,
         alpha: bool = False,
-        time_source: Callable = time.time,
+        time_source: Callable[[], float] = time.time,
         scaling_function: Callable = pygame.transform.scale,
         tall_sprites: int = 0,
         sprite_damage_height: int = 0,
@@ -73,7 +73,7 @@ def __init__(
         self.scaling_function = scaling_function
         self.tall_sprites = tall_sprites
         self.sprite_damage_height = sprite_damage_height
-        self.map_rect = None
+        self.map_rect = Rect(0, 0, 0, 0)
 
         # internal private defaults
         if colorkey and alpha: