Commit Graph

334 Commits

Author SHA1 Message Date
nulano
e4210eb8d7 fix ImageFile references
(cherry picked from commit 6ac071782f)
2020-06-27 15:30:45 +02:00
Hugo van Kemenade
92561bdcdc
Merge pull request #4697 from nulano/docs-imageshow 2020-06-27 14:09:44 +03:00
nulano
6c1ff252d6 check run-time version numbers where available, add docs 2020-06-21 18:58:39 +10:00
nulano
23b771973d Merge remote-tracking branch 'upstream/master' into docs-imageshow 2020-06-20 13:08:47 +02:00
nulano
c40b0e5426 fix some docs links 2020-06-14 17:16:15 +02:00
nulano
255bd0caef create docs section Internal Modules 2020-06-14 16:39:23 +02:00
nulano
eb150c5518 sort docs index 2020-06-14 14:48:56 +02:00
nulano
eab2260313 add docs for ImageDraw2 based on ImageDraw, fix ImageDraw links 2020-06-14 14:48:22 +02:00
nulano
f19e3ec124 promote JpegPresets from autodoc section 2020-06-14 13:55:19 +02:00
nulano
4a9afc79bf improve ImageShow docs 2020-06-14 13:55:19 +02:00
nulano
d05a08a298 formatting improvements
Co-authored-by: Hugo <hugovk@users.noreply.github.com>
2020-06-14 06:49:00 +02:00
nulano
097104278b add docs for features module 2020-06-13 04:28:02 +02:00
Andrew Murray
bb01312ba9 Improved formatting 2020-06-11 22:42:13 +10:00
Andrew Murray
402a59f6ec Fixed formatting [ci skip] 2020-06-08 13:17:08 +10:00
Hugo
cda682efc4 Parameter values in code formatting 2020-06-04 11:45:13 +03:00
Hugo van Kemenade
95f3f359b7
Fix name
Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com>
2020-06-03 11:23:24 +03:00
Hugo
14302aa53d Fix parameter formatting 2020-06-02 22:14:36 +03:00
Hugo
87de783226 Replace simple code formatting with :py:meth: markup 2020-06-02 21:48:53 +03:00
Hugo
087e42f743 Move OpenType docs link to a reference 2020-06-02 21:28:34 +03:00
Hugo
dc0c7bea37 Update ImageDraw docs formatting and links 2020-06-02 21:16:13 +03:00
Hugo van Kemenade
b8bc307691
Merge pull request #4604 from radarhere/imagegrab
Updated ImageGrab documentation now that Linux is supported
2020-05-31 23:20:51 +03:00
Hugo
f271bc8b2f Link pilfont to its new home in pillow-scripts 2020-05-21 00:17:56 +03:00
Andrew Murray
6669ffd053 Updated documentation now that Linux is supported 2020-05-03 13:06:25 +10:00
Hugo
94c7af7596 Replace spaces with tabs and add to pre-commit linting 2020-05-01 21:23:39 +03:00
Andrew Murray
b2f187c4ec Added multiline text example [ci skip] 2020-04-12 15:11:29 +10:00
Andrew Murray
417cbd1557 Document getexif [ci skip] 2020-04-11 18:01:13 +10:00
Andrew Murray
f1f177ce80 Fixed error making HTML from docs 2020-04-06 19:41:38 +10:00
Hugo van Kemenade
b5cf165f9e
Merge pull request #4260 from nulano/imagegrab_xcb
ImageGrab.grab() for Linux with XCB
2020-03-31 23:03:21 +03:00
Hugo van Kemenade
c6115c1ceb
Merge pull request #4230 from dwastberg/new_chops
Added three new channel operations
2020-03-31 10:24:44 +03:00
Andrew Murray
790ff223fc Updated versions 2020-03-24 19:52:27 +11:00
nulano
0bcc7be89b xcb screengrab docs and fixes 2020-03-24 19:46:40 +11:00
Andrew Murray
04f7c75466 Use context manager when opening images [ci skip] 2020-02-29 10:29:44 +11:00
Dag Wästberg
2e02500fa6 change function names to snake_case 2020-02-19 19:38:53 +11:00
Dag Wästberg
13c1b7070d add Overlay chop 2020-02-19 19:24:36 +11:00
Dag Wästberg
c8a46ef387 update docs 2020-02-19 19:23:09 +11:00
Hugo van Kemenade
0e993c4740
Merge pull request #4334 from radarhere/outline_width
Allow explicit zero width to hide outline
2020-02-15 14:30:12 +02:00
Andrew Murray
1c102fd040 Updated spacing defaults [ci skip] 2020-01-18 10:26:20 +11:00
Andrew Murray
56f30ef792 Allow explicit zero width to hide outline 2020-01-08 21:55:15 +11:00
Jon Dufresne
4cd4adddc3 Improve handling of file resources
Follow Python's file object semantics. User code is responsible for
closing resources (usually through a context manager) in a deterministic
way.

To achieve this, remove __del__ functions. These functions used to
closed open file handlers in an attempt to silence Python
ResourceWarnings. However, using __del__ has the following drawbacks:

- __del__ isn't called until the object's reference count reaches 0.
  Therefore, resource handlers remain open or in use longer than
  necessary.

- The __del__ method isn't guaranteed to execute on system exit. See the
  Python documentation:

  https://docs.python.org/3/reference/datamodel.html#object.__del__

  > It is not guaranteed that __del__() methods are called for objects
  > that still exist when the interpreter exits.

- Exceptions that occur inside __del__ are ignored instead of raised.
  This has the potential of hiding bugs. This is also in the Python
  documentation:

  > Warning: Due to the precarious circumstances under which __del__()
  > methods are invoked, exceptions that occur during their execution
  > are ignored, and a warning is printed to sys.stderr instead.

Instead, always close resource handlers when they are no longer in use.
This will close the file handler at a specified point in the user's code
and not wait until the interpreter chooses to. It is always guaranteed
to run. And, if an exception occurs while closing the file handler, the
bug will not be ignored.

Now, when code receives a ResourceWarning, it will highlight an area
that is mishandling resources. It should not simply be silenced, but
fixed by closing resources with a context manager.

All warnings that were emitted during tests have been cleaned up. To
enable warnings, I passed the `-Wa` CLI option to Python. This exposed
some mishandling of resources in ImageFile.__init__() and
SpiderImagePlugin.loadImageSeries(), they too were fixed.
2019-10-12 08:27:17 -07:00
Andrew Murray
fab0205abc Updated documentation [ci skip] 2019-10-08 21:12:15 +11:00
Hugo
f0a87e25a4 Drop support for EOL PyQt4 and PySide 2019-09-30 17:58:31 +03:00
Hugo van Kemenade
310d2c9005
Add option to capture all monitors on Windows (#3950)
Add option to capture all monitors on Windows
2019-09-27 08:47:55 +03:00
nulano
3c311f5619 add version added [ci skip] 2019-09-27 00:58:32 +02:00
nulano
6a2d8f8da0 rename parameter, add note to docs 2019-09-20 17:35:08 +02:00
Hugo
f792ab6c02 RST uses double backticks for code (MD uses 1) 2019-09-13 08:56:33 +03:00
Andrew Murray
da39d40342
Merge pull request #3978 from radarhere/stroke
Added text stroking
2019-09-06 19:14:49 +10:00
nulano
fa6b80fddf add option to capture all monitors on Windows 2019-08-15 20:03:33 +10:00
Andrew Murray
4283683948 Corrected note syntax [ci skip] 2019-08-03 23:24:28 +10:00
Andrew Murray
f93a5d0972 Added text stroking 2019-07-29 06:40:03 +10:00
Andrew Murray
dfed1424d1 Improved ImageFont documentation 2019-07-25 20:04:45 +10:00
Jon Dufresne
8fac23b3df Clean up several Sphinx warnings
Appeared as:

    Pillow/docs/reference/ImageDraw.rst:137: WARNING: Unexpected indentation.
    Pillow/docs/reference/ImageDraw.rst:164: WARNING: Unexpected indentation.
    Pillow/docs/reference/ImageDraw.rst:177: WARNING: Unexpected indentation.
    Pillow/docs/reference/ImageDraw.rst:208: WARNING: Unexpected indentation.
    Pillow/docs/reference/ImageStat.rst:24: WARNING: Explicit markup ends without a blank line; unexpected unindent.
2019-07-06 17:12:09 -07:00
Hugo
a0191dae1e
Documentation for Image module (#3776)
Documentation for Image module
2019-06-28 19:49:45 +03:00
Hugo
57e3af4afb Fix typo 2019-06-28 18:47:17 +03:00
Hugo
73884576d4 Some styling and wording 2019-06-24 11:04:13 +03:00
Hugo
72bf9f6529 Use the common test-suite image 2019-06-24 10:48:33 +03:00
Hugo
fd1d779ae1 Strip trailing whitespace 2019-06-24 10:45:53 +03:00
Hugo
169961649d
Merge pull request #3848 from radarhere/pa
Improved palette handling for LA and PA modes
2019-06-05 22:32:44 +03:00
Andrew Murray
8be6609243 Added PA mode to docs [ci skip] 2019-05-18 20:41:59 +10:00
Andrew Murray
110dd6236f Highlight function [ci skip] 2019-05-08 12:54:12 +10:00
Hugo
82d9ea5eac
Merge pull request #3808 from radarhere/imagegrab
Added option to include layered windows in ImageGrab.grab on Windows
2019-05-04 16:00:43 +03:00
Hugo
c15dc4d7ca
Document format limitations of ImageStat.Stat.extrema (#3661)
Document format limitations of ImageStat.Stat.extrema
2019-05-03 22:14:14 +03:00
Andrew Murray
70038bd71e Added option to include layered windows in ImageGrab.grab on Windows 2019-04-26 20:09:46 +10:00
Andrew Murray
31340bb3c6 Corrected names in documentation 2019-04-24 06:19:17 +10:00
Andrew Murray
0557ecbb3e Document class members automatically 2019-04-21 23:28:08 +10:00
Andrew Murray
93b96a6cb8 Improved documentation 2019-04-21 23:27:31 +10:00
abojja9
c4daa87415 Add documentation to Image module 2019-04-06 13:42:22 -07:00
Andrew Murray
7fd0a1493a Changed wording [ci skip] 2019-03-31 14:36:39 +11:00
Hugo
90886b1888
Merge branch 'master' into imagecms-deprecations 2019-03-27 12:03:54 +02:00
Hugo
30841fe808
Merge pull request #3737 from jdufresne/quotes
Add backticks around Python classes and modules in open_files.rst
2019-03-23 08:31:15 +00:00
Jon Dufresne
d31bee5e35 Add backticks around Python classes and modules in open_files.rst 2019-03-22 06:12:08 -07:00
Jon Dufresne
deb8a7aadd Remove additional references to removed handles_eof
handles_eof was removed in 90760a5f30.
2019-03-22 05:58:22 -07:00
Ben Yang
8bd4bbb808 implemented language parameter for multiline ImageDraw methods, updated release notes 2019-03-11 20:21:52 -07:00
Ben Yang
515244b672 moved language parameter in ImageDraw documentation 2019-03-11 18:56:22 -07:00
Ben Yang
c6ad867178 added proper documentation for ImageFont.getsize() 2019-03-11 18:56:22 -07:00
Ben Yang
d5bbf01254 moved 'language' parameter to last parameter in relevant functions 2019-03-11 18:56:22 -07:00
Ben Yang
8624efd283 added ability to set language for text rendering 2019-03-11 18:55:46 -07:00
Hugo
6f24eda48a Document format limitations of ImageStat.Stat.extrema and recommend more efficient Image.getextrema 2019-03-06 17:49:25 +02:00
Andrew Murray
7477036230
Merge branch 'master' into imagecms-deprecations 2019-02-21 20:00:27 +11:00
Hugo
186f7d943b Document deprecation 2019-02-14 23:44:07 +02:00
Hugo
3ff70c2afc
Merge branch 'master' into imagecms-deprecations 2019-02-13 15:45:28 +02:00
Andrew Murray
4fe63e44d7 Fixed typo [ci skip] 2019-02-10 12:33:16 +11:00
Hugo
7d157bd825 Add warnings to deprecated CMS profile attributes 2019-01-28 15:40:19 +02:00
Andrew Murray
32c344b7ce Added note about ImageDraw operations that exceed image bounds [ci skip] 2019-01-27 22:10:54 +11:00
Hugo
398d2f0c15
Merge pull request #3522 from radarhere/imagechops
Improved ImageChops documentation
2019-01-01 12:21:28 +02:00
Andrew Murray
fc354cabaa Added method 2019-01-01 14:11:52 +11:00
Andrew Murray
671f7a392d Allow RGBA value for P image putpixel 2018-12-31 13:37:04 +11:00
Andrew Murray
3f6282e259 Allow RGB value for P image putpixel 2018-12-31 11:35:15 +11:00
Andrew Murray
b0330047ff Minor edit 2018-12-12 00:53:31 +11:00
Hugo
94f4c4a682
Apply suggestions from code review
Minor edits

Co-Authored-By: radarhere <3112309+radarhere@users.noreply.github.com>
2018-12-12 00:50:32 +11:00
Andrew Murray
91f727051b Updated open files documentation 2018-12-11 14:39:10 +11:00
Andrew Murray
e805401403 Added documentation for negative index pixel access [ci skip] 2018-11-05 21:30:04 +11:00
Andrew Murray
1e305380ae
Merge pull request #3094 from hugovk/add-width-to-shapes
Add line width parameter to rectangle and ellipse-based shapes
2018-09-29 23:21:03 +10:00
Hugo
1b9a1c7ed7
Merge pull request #3279 from radarhere/pyside2
Added PySide2
2018-09-26 13:16:31 +03:00
Hugo
292fa6120e 'btt' (bottom to top) is not supported by libraqm 2018-09-18 13:41:55 +03:00
Hugo
e266b033d1 Update version added 2018-09-16 23:41:24 +03:00
Andrew Murray
53acbfc4d5 Added versionadded [ci skip] 2018-09-16 22:30:11 +10:00
Andrew Murray
f3842460ba Added line joints 2018-09-16 21:29:09 +10:00
Hugo
fbe5bdb6b6 Also apply width to pieslice's inner lines 2018-09-01 14:40:36 +03:00
Andrew Murray
df328a89a4 Added PySide2 2018-08-25 00:51:50 +10:00
Hugo
d6e3ef85c2 Add width parameter to arc, chord, ellipse, pieslice 2018-07-02 11:26:42 +03:00
Hugo
9dedbff713 Add width parameter to rectangle 2018-07-02 11:21:30 +03:00
Hugo
d6fa286e20
Merge pull request #3200 from radarhere/url
Updated redirected URLs
2018-06-30 11:21:55 +03:00
Andrew Murray
d9653a48c7 Added file handling links in documentation 2018-06-30 16:44:59 +10:00
Andrew Murray
bf96b9f87a Updated redirected URLs [ci skip] 2018-06-23 10:58:41 +10:00
Jon Dufresne
01c06ad6c6 Update Python 2 doc URLs to Python 3
Python 3 docs are more actively maintained and are the future.
2018-06-09 21:04:34 -07:00
Andrew Murray
3d82672404 Added getrgb hsb color string 2018-05-31 06:14:29 +10:00
Andrew Murray
b50f63430f Added getrgb hsv color string 2018-05-31 06:13:22 +10:00
Hugo
b6f337fa60 Clarify bounding box for arc, chord, ellipse, pieslice 2018-05-06 16:07:04 +03:00
Hugo
572c06f6cc
Merge pull request #3095 from hugovk/rm-del-draw
Remove 'del draw' from code example
2018-04-22 20:54:01 +03:00
Hugo
cbfc832ccd Remove 'del draw' from code example 2018-04-14 19:00:55 +03:00
Alexander
bdd8dc40f6 Return RankFilter and UnsharpMask order [ci skip] 2018-04-12 12:21:14 +03:00
Alexander
25a5f95d21 Add Color3DLUT to docs 2018-04-11 13:36:48 +03:00
Hugo
7f7d5aa183
Move intro text below its header
Allows hotlinking to include relevant intro:
https://pillow.readthedocs.io/en/latest/reference/Image.html#create-thumbnails
2018-02-28 14:50:02 +02:00
Hugo
4936b447f0
Merge pull request #2985 from Metallicow/trim-trailing-space
Trim trailing whitespace
2018-02-27 12:00:15 +02:00
Hugo
5ba51eb7e0
Merge pull request #3000 from radarhere/imagedraw
Correct reference to Image.new method
2018-02-27 11:55:18 +02:00
Andrew Murray
fc3c4c0119 Corrected reference to method 2018-02-14 20:09:00 +11:00
Andrew Murray
aa0ee9feab Rearranged classes into alphabetical order 2018-01-30 20:13:51 +11:00
Metallicow
b13025129b Trim trailing whitespace docs dir 2018-01-27 00:04:46 -06:00
Andrew Murray
1f40684743 Improved documentation 2017-12-30 21:23:04 +11:00
Lukas Waymann
4960da0519 Correct error in ImageDraw documentation [ci skip]
The first parameter of several functions is described as "four points".
It should be "two points" or "four coordinates".
2017-11-15 11:34:51 +01:00
Hasan Yusuf Ahmed
d891347b89
Corrected line 45 parameter name/documentation mismatch 2017-11-01 15:17:07 -04:00
Hasan Yusuf Ahmed
ee1f814479
Update PixelAccess.rst
Corrected parameter-name documentation mismatch.
2017-11-01 14:36:40 -04:00
Hugo
dfafd51a2c Link to maintained version of aggdraw
See https://github.com/pytroll/aggdraw/issues/11
2017-10-23 18:45:57 +03:00
Eric Soroos
306dcddc0b typos 2017-10-02 12:04:27 +00:00
Eric Soroos
fb04f88147 Block Allocator docs 2017-10-02 11:50:17 +00:00
wiredfool
0f17f0e5c0 Merge pull request #2281 from wilsonge/patch-1
Add note about aspect ratio to documentation
2017-10-01 20:16:00 +01:00
Andrew Murray
7e980d4897 Corrected docs syntax 2017-09-22 20:29:20 +10:00
Alexander
6900a7707f ImageFilter.BoxBlur 2017-09-14 01:59:25 +03:00
Andrew Murray
f5d6d8e57a Fixed documentation syntax [ci skip] 2017-09-02 11:21:12 +10:00
Alexander
b46b5c4e84 release notes
autodocs
fix docstring
note for `Image.split`
2017-08-12 01:24:53 +03:00
Andrew Murray
a05c2cf7ff Improved ImageDraw documentation 2017-07-16 15:22:46 +10:00
Andrew Murray
f33976f81d Corrected class name in ImageDraw docs 2017-07-16 15:21:26 +10:00
Jani Šumak
f8fb58f925 Added the description of the filename attribute to images.rst
Images created with `open` have a filename attribute, but the documentation does not mention it. This lead to a short, but interesting discussion on [Stackoverflow](https://stackoverflow.com/questions/45087638/get-image-filename-from-image-pil/).
2017-07-14 22:57:31 +01:00
wiredfool
b9b5d39f2b Merge pull request #2595 from wiredfool/issue_1911
Image.Image.alpha_composite Added
2017-07-01 11:43:58 +01:00
wiredfool
8feac899dd Merge pull request #2576 from wiredfool/pr_2284
Complex Text Support
2017-07-01 10:45:18 +01:00
wiredfool
9f7aae3505 Doc changes/additions 2017-06-29 07:02:02 -07:00
wiredfool
92b8db1935 Docs, wording 2017-06-29 05:14:43 -07:00
Andrew Murray
91215c384d Fixed typo [ci skip] 2017-06-24 15:04:37 +10:00
Fahad Al-Saidi
e07a254ed9 update 2017-06-21 14:00:14 -07:00
Fahad Al-Saidi
6dc4c7ea06 improve docs for CTL 2017-06-21 14:00:14 -07:00
shamsa
fe871bb736 Document complex text layout features. 2017-06-21 14:00:13 -07:00
Garland Trice
7b77ee5379 Fixing small typo
Working on a small project, reading thru the docs and noticed this.
2017-06-21 19:02:51 +10:00
wiredfool
c3e041e9e6 Merge branch 'master' into rm-deprecated-fn 2017-06-13 13:32:38 +01:00
Andrew Murray
dcd964fb22 Updated limits documentation [ci skip] 2017-06-08 20:21:00 +10:00
hugovk
4c3107c940 Remove docs about deprecated and already removed code 2017-05-27 22:16:40 +03:00
Andrew Murray
424a09ecad Updated references to point to existing files [ci skip] 2017-05-06 23:20:34 +10:00
George Wilson
1c94c9fbf2 Use suggested doc block 2017-04-22 20:02:35 +01:00
Bjorn
c7b7f5aa69 Add missing colon in :command:... 2017-04-04 23:10:22 +02:00
wiredfool
2030bf76f6 New Image methods 2017-04-03 13:21:50 -07:00
wiredfool
36a22e2d63 s/lena/hopper/ 2017-03-11 13:50:19 +00:00