Skip to content

Commit

Permalink
Added examples for updating code
Browse files Browse the repository at this point in the history
  • Loading branch information
radarhere committed Sep 3, 2022
1 parent 4783ecf commit 780de80
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/deprecations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,40 @@ Deprecated Use
:py:meth:`.ImageDraw2.Draw.textsize` :py:meth:`.ImageDraw2.Draw.textbbox` and :py:meth:`.ImageDraw2.Draw.textlength`
=========================================================================== =============================================================================================================

Previous code:

.. code-block:: python
from PIL import Image, ImageDraw, ImageFont
font = ImageFont.truetype("Tests/fonts/FreeMono.ttf")
width, height = font.getsize("Hello world")
left, top = font.getoffset("Hello world")
im = Image.new("RGB", (100, 100))
draw = ImageDraw.Draw(im)
width, height = draw.textsize("Hello world")
width, height = font.getsize_multiline("Hello\nworld")
width, height = draw.multiline_textsize("Hello\nworld")
Use instead:

.. code-block:: python
from PIL import Image, ImageDraw, ImageFont
font = ImageFont.truetype("Tests/fonts/FreeMono.ttf")
left, top, right, bottom = font.getbbox("Hello world")
width, height = right - left, bottom - top
im = Image.new("RGB", (100, 100))
draw = ImageDraw.Draw(im)
width = draw.textlength("Hello world")
left, top, right, bottom = draw.multiline_textbbox((0, 0), "Hello\nworld")
width, height = right - left, bottom - top
Removed features
----------------

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/ImageDraw.rst
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,9 @@ Methods
.. deprecated:: 9.2.0

See https://pillow.readthedocs.io/en/stable/releasenotes/9.2.0.html#font-size-and-offset-methods
for more information.

Use :py:meth:`textlength()` to measure the offset of following text with
1/64 pixel precision.
Use :py:meth:`textbbox()` to get the exact bounding box based on an anchor.
Expand Down Expand Up @@ -495,6 +498,9 @@ Methods
.. deprecated:: 9.2.0

See https://pillow.readthedocs.io/en/stable/releasenotes/9.2.0.html#font-size-and-offset-methods
for more information.

Use :py:meth:`.multiline_textbbox` instead.

Return the size of the given string, in pixels.
Expand Down
34 changes: 34 additions & 0 deletions docs/releasenotes/9.2.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,40 @@ Deprecated Use
:py:meth:`.ImageDraw2.Draw.textsize` :py:meth:`.ImageDraw2.Draw.textbbox` and :py:meth:`.ImageDraw2.Draw.textlength`
=========================================================================== =============================================================================================================

Previous code:

.. code-block:: python
from PIL import Image, ImageDraw, ImageFont
font = ImageFont.truetype("Tests/fonts/FreeMono.ttf")
width, height = font.getsize("Hello world")
left, top = font.getoffset("Hello world")
im = Image.new("RGB", (100, 100))
draw = ImageDraw.Draw(im)
width, height = draw.textsize("Hello world")
width, height = font.getsize_multiline("Hello\nworld")
width, height = draw.multiline_textsize("Hello\nworld")
Use instead:

.. code-block:: python
from PIL import Image, ImageDraw, ImageFont
font = ImageFont.truetype("Tests/fonts/FreeMono.ttf")
left, top, right, bottom = font.getbbox("Hello world")
width, height = right - left, bottom - top
im = Image.new("RGB", (100, 100))
draw = ImageDraw.Draw(im)
width = draw.textlength("Hello world")
left, top, right, bottom = draw.multiline_textbbox((0, 0), "Hello\nworld")
width, height = right - left, bottom - top
API Additions
=============

Expand Down
15 changes: 15 additions & 0 deletions src/PIL/ImageFont.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,9 @@ def getsize(self, text, *args, **kwargs):
"""
.. deprecated:: 9.2.0
For more information, see
https://pillow.readthedocs.io/en/stable/releasenotes/9.2.0.html#deprecations.
Use :py:meth:`.getbbox` or :py:meth:`.getlength` instead.
Returns width and height (in pixels) of given text.
Expand Down Expand Up @@ -428,6 +431,9 @@ def getsize(
"""
.. deprecated:: 9.2.0
For more information, see
https://pillow.readthedocs.io/en/stable/releasenotes/9.2.0.html#deprecations.
Use :py:meth:`getlength()` to measure the offset of following text with
1/64 pixel precision.
Use :py:meth:`getbbox()` to get the exact bounding box based on an anchor.
Expand Down Expand Up @@ -498,6 +504,9 @@ def getsize_multiline(
"""
.. deprecated:: 9.2.0
For more information, see
https://pillow.readthedocs.io/en/stable/releasenotes/9.2.0.html#deprecations.
Use :py:meth:`.ImageDraw.multiline_textbbox` instead.
Returns width and height (in pixels) of given text if rendered in font
Expand Down Expand Up @@ -557,6 +566,9 @@ def getoffset(self, text):
"""
.. deprecated:: 9.2.0
For more information, see
https://pillow.readthedocs.io/en/stable/releasenotes/9.2.0.html#deprecations.
Use :py:meth:`.getbbox` instead.
Returns the offset of given text. This is the gap between the
Expand Down Expand Up @@ -851,6 +863,9 @@ def getsize(self, text, *args, **kwargs):
"""
.. deprecated:: 9.2.0
For more information, see
https://pillow.readthedocs.io/en/stable/releasenotes/9.2.0.html#deprecations.
Use :py:meth:`.getbbox` or :py:meth:`.getlength` instead.
"""
deprecate("getsize", 10, "getbbox or getlength")
Expand Down

0 comments on commit 780de80

Please sign in to comment.