Skip to content

Remove remaining :rtype:s from docstrings #9742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akx wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −57
Open

Remove remaining :rtype:s from docstrings #9742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions src/PIL/Image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -978,7 +978,6 @@ def load(self) -> core.PixelAccess | None:
operations. See :ref:`file-handling` for more information.

:returns: An image access object.
:rtype: :py:class:`.PixelAccess`
"""
if self._im is not None and self.palette and self.palette.dirty:
# realize palette
Expand Down Expand Up @@ -1062,7 +1061,6 @@ def convert(
:data:`Palette.ADAPTIVE`.
:param colors: Number of colors to use for the :data:`Palette.ADAPTIVE`
palette. Defaults to 256.
:rtype: :py:class:`~PIL.Image.Image`
:returns: An :py:class:`~PIL.Image.Image` object.
"""

Expand Down Expand Up @@ -1358,7 +1356,6 @@ def copy(self) -> Image:
Copies this image. Use this method if you wish to paste things
into an image, but still retain the original.

:rtype: :py:class:`~PIL.Image.Image`
:returns: An :py:class:`~PIL.Image.Image` object.
"""
self.load()
Expand All @@ -1375,7 +1372,6 @@ def crop(self, box: tuple[float, float, float, float] | None = None) -> Image:
Note: Prior to Pillow 3.4.0, this was a lazy operation.

:param box: The crop rectangle, as a (left, upper, right, lower)-tuple.
:rtype: :py:class:`~PIL.Image.Image`
:returns: An :py:class:`~PIL.Image.Image` object.
"""

Expand Down Expand Up @@ -1472,7 +1468,6 @@ def getbands(self) -> tuple[str, ...]:
For example, ``getbands`` on an RGB image returns ("R", "G", "B").

:returns: A tuple containing band names.
:rtype: tuple
"""
return ImageMode.getmode(self.mode).bands

Expand Down
69 changes: 18 additions & 51 deletions src/PIL/ImageChops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,13 @@


def constant(image: Image.Image, value: int) -> Image.Image:
"""Fill a channel with a given gray level.

:rtype: :py:class:`~PIL.Image.Image`
"""
"""Fill a channel with a given gray level."""

return Image.new("L", image.size, value)


def duplicate(image: Image.Image) -> Image.Image:
"""Copy a channel. Alias for :py:meth:`PIL.Image.Image.copy`.

:rtype: :py:class:`~PIL.Image.Image`
"""
"""Copy a channel. Alias for :py:meth:`PIL.Image.Image.copy`."""

return image.copy()

Expand All @@ -43,8 +37,6 @@ def invert(image: Image.Image) -> Image.Image:
Invert an image (channel). ::

out = MAX - image

:rtype: :py:class:`~PIL.Image.Image`
"""

image.load()
Expand All @@ -57,8 +49,6 @@ def lighter(image1: Image.Image, image2: Image.Image) -> Image.Image:
the lighter values. ::

out = max(image1, image2)

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -72,8 +62,6 @@ def darker(image1: Image.Image, image2: Image.Image) -> Image.Image:
the darker values. ::

out = min(image1, image2)

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -87,8 +75,6 @@ def difference(image1: Image.Image, image2: Image.Image) -> Image.Image:
images. ::

out = abs(image1 - image2)

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -104,8 +90,6 @@ def multiply(image1: Image.Image, image2: Image.Image) -> Image.Image:
you multiply with a solid white image, the image is unaffected. ::

out = image1 * image2 / MAX

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -118,8 +102,6 @@ def screen(image1: Image.Image, image2: Image.Image) -> Image.Image:
Superimposes two inverted images on top of each other. ::

out = MAX - ((MAX - image1) * (MAX - image2) / MAX)

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -130,8 +112,6 @@ def screen(image1: Image.Image, image2: Image.Image) -> Image.Image:
def soft_light(image1: Image.Image, image2: Image.Image) -> Image.Image:
"""
Superimposes two images on top of each other using the Soft Light algorithm

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -142,8 +122,6 @@ def soft_light(image1: Image.Image, image2: Image.Image) -> Image.Image:
def hard_light(image1: Image.Image, image2: Image.Image) -> Image.Image:
"""
Superimposes two images on top of each other using the Hard Light algorithm

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -154,8 +132,6 @@ def hard_light(image1: Image.Image, image2: Image.Image) -> Image.Image:
def overlay(image1: Image.Image, image2: Image.Image) -> Image.Image:
"""
Superimposes two images on top of each other using the Overlay algorithm

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -168,11 +144,11 @@ def add(
) -> Image.Image:
"""
Adds two images, dividing the result by scale and adding the
offset. If omitted, scale defaults to 1.0, and offset to 0.0. ::
offset. If omitted, scale defaults to 1.0, and offset to 0.0.

out = ((image1 + image2) / scale + offset)
::

:rtype: :py:class:`~PIL.Image.Image`
out = ((image1 + image2) / scale + offset)
"""

image1.load()
Expand All @@ -185,11 +161,11 @@ def subtract(
) -> Image.Image:
"""
Subtracts two images, dividing the result by scale and adding the offset.
If omitted, scale defaults to 1.0, and offset to 0.0. ::
If omitted, scale defaults to 1.0, and offset to 0.0.

out = ((image1 - image2) / scale + offset)
::

:rtype: :py:class:`~PIL.Image.Image`
out = ((image1 - image2) / scale + offset)
"""

image1.load()
Expand All @@ -198,11 +174,11 @@ def subtract(


def add_modulo(image1: Image.Image, image2: Image.Image) -> Image.Image:
"""Add two images, without clipping the result. ::
"""Add two images, without clipping the result.

out = ((image1 + image2) % MAX)
::

:rtype: :py:class:`~PIL.Image.Image`
out = ((image1 + image2) % MAX)
"""

image1.load()
Expand All @@ -211,11 +187,11 @@ def add_modulo(image1: Image.Image, image2: Image.Image) -> Image.Image:


def subtract_modulo(image1: Image.Image, image2: Image.Image) -> Image.Image:
"""Subtract two images, without clipping the result. ::
"""Subtract two images, without clipping the result.

out = ((image1 - image2) % MAX)
::

:rtype: :py:class:`~PIL.Image.Image`
out = ((image1 - image2) % MAX)
"""

image1.load()
Expand All @@ -232,8 +208,6 @@ def logical_and(image1: Image.Image, image2: Image.Image) -> Image.Image:
as the second image. ::

out = ((image1 and image2) % MAX)

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -247,8 +221,6 @@ def logical_or(image1: Image.Image, image2: Image.Image) -> Image.Image:
Both of the images must have mode "1". ::

out = ((image1 or image2) % MAX)

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -262,8 +234,6 @@ def logical_xor(image1: Image.Image, image2: Image.Image) -> Image.Image:
Both of the images must have mode "1". ::

out = ((bool(image1) != bool(image2)) % MAX)

:rtype: :py:class:`~PIL.Image.Image`
"""

image1.load()
Expand All @@ -272,10 +242,9 @@ def logical_xor(image1: Image.Image, image2: Image.Image) -> Image.Image:


def blend(image1: Image.Image, image2: Image.Image, alpha: float) -> Image.Image:
"""Blend images using constant transparency weight. Alias for
:py:func:`PIL.Image.blend`.
"""Blend images using constant transparency weight.

:rtype: :py:class:`~PIL.Image.Image`
Alias for :py:func:`PIL.Image.blend`.
"""

return Image.blend(image1, image2, alpha)
Expand All @@ -284,10 +253,9 @@ def blend(image1: Image.Image, image2: Image.Image, alpha: float) -> Image.Image
def composite(
image1: Image.Image, image2: Image.Image, mask: Image.Image
) -> Image.Image:
"""Create composite using transparency mask. Alias for
:py:func:`PIL.Image.composite`.
"""Create composite using transparency mask.

:rtype: :py:class:`~PIL.Image.Image`
Alias for :py:func:`PIL.Image.composite`.
"""

return Image.composite(image1, image2, mask)
Expand All @@ -302,7 +270,6 @@ def offset(image: Image.Image, xoffset: int, yoffset: int | None = None) -> Imag
:param xoffset: The horizontal distance.
:param yoffset: The vertical distance. If omitted, both
distances are set to the same value.
:rtype: :py:class:`~PIL.Image.Image`
"""

if yoffset is None:
Expand Down
1 change: 0 additions & 1 deletion src/PIL/ImageEnhance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ def enhance(self, factor: float) -> Image.Image:
lower factors mean less color (brightness, contrast,
etc), and higher values more. There are no restrictions
on this value.
:rtype: :py:class:`~PIL.Image.Image`
"""
return Image.blend(self.degenerate, self.image, factor)

Expand Down
Loading