doc: add type hints to constructors and methods

Remove type information from parameter documentation, since it's redundant
now.

Signed-off-by: Benjamin Gilbert <[email protected]>

Author: bgilbert

doc/index.rst

@@ -93,7 +93,7 @@ OpenSlide objects
 
 .. module:: openslide
 
-.. class:: OpenSlide(filename)
+.. class:: OpenSlide(filename: str | bytes | ~os.PathLike[typing.Any])
 
    An open whole-slide image.
 
@@ -106,20 +106,20 @@ OpenSlide objects
    The object may be used as a context manager, in which case it will be
    closed upon exiting the context.
 
-   :param str filename: the file to open
+   :param filename: the file to open
    :raises OpenSlideUnsupportedFormatError: if the file is not recognized by
       OpenSlide
    :raises OpenSlideError: if the file is recognized but an error occurred
 
-   .. classmethod:: detect_format(filename)
+   .. classmethod:: detect_format(filename: str | bytes | ~os.PathLike[typing.Any]) -> str | None
 
       Return a string describing the format vendor of the specified file.
       This string is also accessible via the :data:`PROPERTY_NAME_VENDOR`
       property.
 
       If the file is not recognized, return :obj:`None`.
 
-      :param str filename: the file to examine
+      :param filename: the file to examine
 
    .. attribute:: level_count
 
@@ -174,42 +174,42 @@ OpenSlide objects
 
       :type: ~PIL.ImageCms.ImageCmsProfile | None
 
-   .. method:: read_region(location, level, size)
+   .. method:: read_region(location: tuple[int, int], level: int, size: tuple[int, int]) -> ~PIL.Image.Image
 
       Return an RGBA :class:`Image <PIL.Image.Image>` containing the
       contents of the specified region.
 
       Unlike in the C interface, the image data is not premultiplied.
 
-      :param tuple location: ``(x, y)`` tuple giving the top left pixel in
-         the level 0 reference frame
-      :param int level: the level number
-      :param tuple size: ``(width, height)`` tuple giving the region size
+      :param location: ``(x, y)`` tuple giving the top left pixel in the
+         level 0 reference frame
+      :param level: the level number
+      :param size: ``(width, height)`` tuple giving the region size
 
-   .. method:: get_best_level_for_downsample(downsample)
+   .. method:: get_best_level_for_downsample(downsample: float) -> int
 
       Return the best level for displaying the given downsample.
 
-      :param float downsample: the desired downsample factor
+      :param downsample: the desired downsample factor
 
-   .. method:: get_thumbnail(size)
+   .. method:: get_thumbnail(size: tuple[int, int]) -> ~PIL.Image.Image
 
       Return an :class:`Image <PIL.Image.Image>` containing an RGB thumbnail
       of the slide.
 
-      :param tuple size: the maximum size of the thumbnail as a
-         ``(width, height)`` tuple
+      :param size: the maximum size of the thumbnail as a ``(width, height)``
+         tuple
 
-   .. method:: set_cache(cache)
+   .. method:: set_cache(cache: OpenSlideCache) -> None
 
       Use the specified :class:`OpenSlideCache` to store recently decoded
       slide tiles.  By default, the :class:`OpenSlide` has a private cache
       with a default size.
 
-      :param OpenSlideCache cache: a cache object
+      :param cache: a cache object
       :raises OpenSlideVersionError: if OpenSlide is older than version 4.0.0
 
-   .. method:: close()
+   .. method:: close() -> None
 
       Close the OpenSlide object.
 
@@ -266,15 +266,15 @@ reusing it for multiple slide regions::
 Caching
 -------
 
-.. class:: OpenSlideCache(capacity)
+.. class:: OpenSlideCache(capacity: int)
 
    An in-memory tile cache.
 
    Tile caches can be attached to one or more :class:`OpenSlide` objects
    with :meth:`OpenSlide.set_cache` to cache recently-decoded tiles.  By
    default, each :class:`OpenSlide` has its own cache with a default size.
 
-   :param int capacity: the cache capacity in bytes
+   :param capacity: the cache capacity in bytes
    :raises OpenSlideVersionError: if OpenSlide is older than version 4.0.0
 
 
@@ -366,20 +366,20 @@ Exceptions
 Wrapping a Pillow Image
 =======================
 
-.. class:: ImageSlide(file)
+.. class:: ImageSlide(file: str | bytes | ~os.PathLike[typing.Any] | ~PIL.Image.Image)
 
    A wrapper around an :class:`Image <PIL.Image.Image>` object that
    provides an :class:`OpenSlide`-compatible API.
 
    :param file: a filename or :class:`Image <PIL.Image.Image>` object
    :raises OSError: if the file cannot be opened
 
-.. function:: open_slide(filename)
+.. function:: open_slide(filename: str | bytes | ~os.PathLike[typing.Any]) -> OpenSlide | ImageSlide
 
    Return an :class:`OpenSlide` for whole-slide images and an
    :class:`ImageSlide` for other types of images.
 
-   :param str filename: the file to open
+   :param filename: the file to open
    :raises OpenSlideError: if the file is recognized by OpenSlide but an
       error occurred
    :raises OSError: if the file is not recognized at all
@@ -397,19 +397,18 @@ Deep Zoom or a similar format.
 
 .. _`Deep Zoom`: https://docs.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/cc645050(v=vs.95)
 
-.. class:: DeepZoomGenerator(osr, tile_size=254, overlap=1, limit_bounds=False)
+.. class:: DeepZoomGenerator(osr: AbstractSlide, tile_size: int = 254, overlap: int = 1, limit_bounds: bool = False)
 
    A Deep Zoom generator that wraps an
    :class:`OpenSlide <openslide.OpenSlide>` or
    :class:`ImageSlide <openslide.ImageSlide>` object.
 
    :param osr: the slide object
-   :param int tile_size: the width and height of a single tile.  For best
-      viewer performance, ``tile_size + 2 * overlap`` should be a power of two.
-   :param int overlap: the number of extra pixels to add to each interior edge
-      of a tile
-   :param bool limit_bounds: ``True`` to render only the non-empty slide
-      region
+   :param tile_size: the width and height of a single tile.  For best viewer
+      performance, ``tile_size + 2 * overlap`` should be a power of two.
+   :param overlap: the number of extra pixels to add to each interior edge of a
+      tile
+   :param limit_bounds: ``True`` to render only the non-empty slide region
 
    .. attribute:: level_count
 
@@ -437,40 +436,40 @@ Deep Zoom or a similar format.
 
       :type: tuple[tuple[int, int], ...]
 
-   .. method:: get_dzi(format)
+   .. method:: get_dzi(format: str) -> str
 
       Return a string containing the XML metadata for the Deep Zoom ``.dzi``
       file.
 
-      :param str format: the delivery format of the individual tiles
-         (``png`` or ``jpeg``)
+      :param format: the delivery format of the individual tiles (``png`` or
+         ``jpeg``)
 
-   .. method:: get_tile(level, address)
+   .. method:: get_tile(level: int, address: tuple[int, int]) -> ~PIL.Image.Image
 
       Return an RGB :class:`Image <PIL.Image.Image>` for a tile.
 
-      :param int level: the Deep Zoom level
-      :param tuple address: the address of the tile within the level as a
+      :param level: the Deep Zoom level
+      :param address: the address of the tile within the level as a
          ``(column, row)`` tuple
 
-   .. method:: get_tile_coordinates(level, address)
+   .. method:: get_tile_coordinates(level: int, address: tuple[int, int]) -> tuple[tuple[int, int], int, tuple[int, int]]
 
       Return the :meth:`OpenSlide.read_region()
       <openslide.OpenSlide.read_region>` arguments corresponding to the
       specified tile.
 
       Most applications should use :meth:`get_tile()` instead.
 
-      :param int level: the Deep Zoom level
-      :param tuple address: the address of the tile within the level as a
+      :param level: the Deep Zoom level
+      :param address: the address of the tile within the level as a
          ``(column, row)`` tuple
 
-   .. method:: get_tile_dimensions(level, address)
+   .. method:: get_tile_dimensions(level: int, address: tuple[int, int]) -> tuple[int, int]
 
       Return a ``(pixels_x, pixels_y)`` tuple for the specified tile.
 
-      :param int level: the Deep Zoom level
-      :param tuple address: the address of the tile within the level as a
+      :param level: the Deep Zoom level
+      :param address: the address of the tile within the level as a
          ``(column, row)`` tuple