python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-09-21 11:28:58 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added examples for updating code

Browse Source
This commit is contained in:
Andrew Murray 2022-09-03 22:23:05 +10:00
parent 4783ecf41c
commit 780de80e5c
4 changed files with 89 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/deprecations.rst
View File

@ -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
----------------

6
docs/reference/ImageDraw.rst
View File

@ -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.
@ -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.

34
docs/releasenotes/9.2.0.rst
View File

@ -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
=============

15
src/PIL/ImageFont.py
View File

@ -139,6 +139,9 @@ class ImageFont:
"""
.. 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.
@ -428,6 +431,9 @@ class FreeTypeFont:
"""
.. 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.
@ -498,6 +504,9 @@ class FreeTypeFont:
"""
.. 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
@ -557,6 +566,9 @@ class FreeTypeFont:
"""
.. 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
@ -851,6 +863,9 @@ class TransposedFont:
"""
.. 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")