1+
2+
13<!DOCTYPE html>
2- < html class ="writer-html5 " lang ="en " >
4+ < html class ="writer-html5 " lang ="en " data-content_root =" ../../ " >
35< head >
46 < meta charset ="utf-8 " />
57 < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
6- < title > pyvips.error — pyvips 2.2.1 documentation</ title >
7- < link rel ="stylesheet " href ="../../_static/pygments.css " type ="text/css " />
8- < link rel ="stylesheet " href ="../../_static/css/theme.css " type ="text/css " />
9- <!--[if lt IE 9]>
10- <script src="../../_static/js/html5shiv.min.js"></script>
11- <![endif]-->
8+ < title > pyvips.error — pyvips 3.1.0 documentation</ title >
9+ < link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css?v=03e43079 " />
10+ < link rel ="stylesheet " type ="text/css " href ="../../_static/css/theme.css?v=e59714d7 " />
11+
1212
13- < script data-url_root ="../../ " id ="documentation_options " src ="../../_static/documentation_options.js "> </ script >
14- < script src ="../../_static/jquery.js "> </ script >
15- < script src ="../../_static/underscore.js "> </ script >
16- < script src ="../../_static/_sphinx_javascript_frameworks_compat.js "> </ script >
17- < script src ="../../_static/doctools.js "> </ script >
18- < script src ="../../../../_static/collapse.js "> </ script >
13+ < script src ="../../_static/documentation_options.js?v=dd1205ac "> </ script >
14+ < script src ="../../_static/doctools.js?v=9bcbadda "> </ script >
15+ < script src ="../../_static/sphinx_highlight.js?v=dc90522c "> </ script >
16+ < script src ="../../../../_static/collapse.js "> </ script >
1917 < script src ="../../_static/js/theme.js "> </ script >
2018 < link rel ="index " title ="Index " href ="../../genindex.html " />
2119 < link rel ="search " title ="Search " href ="../../search.html " />
2826 < nav data-toggle ="wy-nav-shift " class ="wy-nav-side ">
2927 < div class ="wy-side-scroll ">
3028 < div class ="wy-side-nav-search " >
31- < a href ="../../index.html " class ="icon icon-home "> pyvips
29+
30+
31+
32+ < a href ="../../index.html " class ="icon icon-home ">
33+ pyvips
3234 </ a >
33- < div class ="version ">
34- 2.2
35- </ div >
3635< div role ="search ">
3736 < form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
38- < input type ="text " name ="q " placeholder ="Search docs " />
37+ < input type ="text " name ="q " placeholder ="Search docs " aria-label =" Search docs " />
3938 < input type ="hidden " name ="check_keywords " value ="yes " />
4039 < input type ="hidden " name ="area " value ="default " />
4140 </ form >
7372 < div class ="rst-content ">
7473 < div role ="navigation " aria-label ="Page navigation ">
7574 < ul class ="wy-breadcrumbs ">
76- < li > < a href ="../../index.html " class ="icon icon-home "> </ a > » </ li >
77- < li > < a href ="../index.html "> Module code</ a > » </ li >
78- < li > pyvips.error</ li >
75+ < li > < a href ="../../index.html " class ="icon icon-home " aria-label =" Home " > </ a > </ li >
76+ < li class =" breadcrumb-item " > < a href ="../index.html "> Module code</ a > </ li >
77+ < li class =" breadcrumb-item active " > pyvips.error</ li >
7978 < li class ="wy-breadcrumbs-aside ">
8079 </ li >
8180 </ ul >
8786 < h1 > Source code for pyvips.error</ h1 > < div class ="highlight "> < pre >
8887< span > </ span > < span class ="c1 "> # errors from libvips</ span >
8988
90- < span class ="kn "> import</ span > < span class ="nn "> sys</ span >
91- < span class ="kn "> import</ span > < span class ="nn "> logging</ span >
89+ < span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> logging</ span >
9290
93- < span class ="kn "> from</ span > < span class ="nn "> pyvips</ span > < span class ="kn "> import</ span > < span class ="n "> ffi</ span > < span class ="p "> ,</ span > < span class ="n "> vips_lib</ span > < span class ="p "> ,</ span > < span class ="n "> glib_lib</ span >
91+ < span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> pathlib</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> Path</ span >
92+ < span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> pyvips</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> ffi</ span > < span class ="p "> ,</ span > < span class ="n "> vips_lib</ span > < span class ="p "> ,</ span > < span class ="n "> glib_lib</ span >
9493
9594< span class ="n "> logger</ span > < span class ="o "> =</ span > < span class ="n "> logging</ span > < span class ="o "> .</ span > < span class ="n "> getLogger</ span > < span class ="p "> (</ span > < span class ="vm "> __name__</ span > < span class ="p "> )</ span >
9695
97- < span class ="n "> _is_PY3</ span > < span class ="o "> =</ span > < span class ="n "> sys</ span > < span class ="o "> .</ span > < span class ="n "> version_info</ span > < span class ="p "> [</ span > < span class ="mi "> 0</ span > < span class ="p "> ]</ span > < span class ="o "> ==</ span > < span class ="mi "> 3</ span >
9896
99- < span class ="k "> if</ span > < span class ="n "> _is_PY3</ span > < span class ="p "> :</ span >
100- < span class ="c1 "> # pathlib is not part of Python 2 stdlib</ span >
101- < span class ="kn "> from</ span > < span class ="nn "> pathlib</ span > < span class ="kn "> import</ span > < span class ="n "> Path</ span >
102- < span class ="n "> text_type</ span > < span class ="o "> =</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> Path</ span >
103- < span class ="n "> byte_type</ span > < span class ="o "> =</ span > < span class ="nb "> bytes</ span >
104- < span class ="k "> else</ span > < span class ="p "> :</ span >
105- < span class ="n "> text_type</ span > < span class ="o "> =</ span > < span class ="n "> unicode</ span >
106- < span class ="n "> byte_type</ span > < span class ="o "> =</ span > < span class ="nb "> str</ span >
107-
108-
109- < span class ="k "> def</ span > < span class ="nf "> _to_bytes</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ):</ span >
110- < span class ="sd "> """Convert to a byte string.</ span >
97+ < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> _to_bytes</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ):</ span >
98+ < span class ="w "> </ span > < span class ="sd "> """Convert to a byte string.</ span >
11199
112100< span class ="sd "> Convert a Python unicode string or a pathlib.Path to a utf-8-encoded</ span >
113101< span class ="sd "> byte string. You must call this on strings you pass to libvips.</ span >
114102
115103< span class ="sd "> """</ span >
116- < span class ="k "> if</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="n "> text_type </ span > < span class ="p "> ):</ span >
104+ < span class ="k "> if</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="p " > ( </ span > < span class =" nb " > str </ span > < span class =" p " > , </ span > < span class =" n "> Path </ span > < span class ="p "> ) ):</ span >
117105 < span class ="c1 "> # n.b. str also converts pathlib.Path objects</ span >
118106 < span class ="n "> x</ span > < span class ="o "> =</ span > < span class ="nb "> str</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> )</ span > < span class ="o "> .</ span > < span class ="n "> encode</ span > < span class ="p "> (</ span > < span class ="s1 "> 'utf-8'</ span > < span class ="p "> )</ span >
119107
120108 < span class ="k "> return</ span > < span class ="n "> x</ span >
121109
122110
123- < span class ="k "> def</ span > < span class ="nf "> _to_string</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ):</ span >
124- < span class ="sd "> """Convert to a unicode string.</ span >
111+ < span class ="k "> def</ span > < span class =" w " > </ span > < span class ="nf "> _to_string</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ):</ span >
112+ < span class =" w " > </ span > < span class ="sd "> """Convert to a unicode string.</ span >
125113
126114< span class ="sd "> If x is a byte string, assume it is utf-8 and decode to a Python unicode</ span >
127115< span class ="sd "> string. You must call this on text strings you get back from libvips.</ span >
@@ -131,14 +119,14 @@ <h1>Source code for pyvips.error</h1><div class="highlight"><pre>
131119 < span class ="n "> x</ span > < span class ="o "> =</ span > < span class ="s1 "> 'NULL'</ span >
132120 < span class ="k "> else</ span > < span class ="p "> :</ span >
133121 < span class ="n "> x</ span > < span class ="o "> =</ span > < span class ="n "> ffi</ span > < span class ="o "> .</ span > < span class ="n "> string</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> )</ span >
134- < span class ="k "> if</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="n " > byte_type </ span > < span class ="p "> ):</ span >
122+ < span class ="k "> if</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="nb " > bytes </ span > < span class ="p "> ):</ span >
135123 < span class ="n "> x</ span > < span class ="o "> =</ span > < span class ="n "> x</ span > < span class ="o "> .</ span > < span class ="n "> decode</ span > < span class ="p "> (</ span > < span class ="s1 "> 'utf-8'</ span > < span class ="p "> )</ span >
136124
137125 < span class ="k "> return</ span > < span class ="n "> x</ span >
138126
139127
140- < span class ="k "> def</ span > < span class ="nf "> _to_string_copy</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ):</ span >
141- < span class ="sd "> """Convert to a unicode string, and auto-free.</ span >
128+ < span class ="k "> def</ span > < span class =" w " > </ span > < span class ="nf "> _to_string_copy</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ):</ span >
129+ < span class =" w " > </ span > < span class ="sd "> """Convert to a unicode string, and auto-free.</ span >
142130
143131< span class ="sd "> As _to_string(), but also tag x as a pointer to a memory area that must</ span >
144132< span class ="sd "> be freed with g_free().</ span >
@@ -147,16 +135,18 @@ <h1>Source code for pyvips.error</h1><div class="highlight"><pre>
147135 < span class ="k "> return</ span > < span class ="n "> _to_string</ span > < span class ="p "> (</ span > < span class ="n "> ffi</ span > < span class ="o "> .</ span > < span class ="n "> gc</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="n "> glib_lib</ span > < span class ="o "> .</ span > < span class ="n "> g_free</ span > < span class ="p "> ))</ span >
148136
149137
150- < div class ="viewcode-block " id ="Error "> < a class ="viewcode-back " href ="../../error.html#pyvips.error.Error "> [docs]</ a > < span class ="k "> class</ span > < span class ="nc "> Error</ span > < span class ="p "> (</ span > < span class ="ne "> Exception</ span > < span class ="p "> ):</ span >
151- < span class ="sd "> """An error from vips.</ span >
138+ < div class ="viewcode-block " id ="Error ">
139+ < a class ="viewcode-back " href ="../../error.html#pyvips.error.Error "> [docs]</ a >
140+ < span class ="k "> class</ span > < span class ="w "> </ span > < span class ="nc "> Error</ span > < span class ="p "> (</ span > < span class ="ne "> Exception</ span > < span class ="p "> ):</ span >
141+ < span class ="w "> </ span > < span class ="sd "> """An error from vips.</ span >
152142
153143< span class ="sd "> Attributes:</ span >
154144< span class ="sd "> message (str): a high-level description of the error</ span >
155145< span class ="sd "> detail (str): a string with some detailed diagnostics</ span >
156146
157147< span class ="sd "> """</ span >
158148
159- < span class ="k "> def</ span > < span class ="fm "> __init__</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> message</ span > < span class ="p "> ,</ span > < span class ="n "> detail</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ):</ span >
149+ < span class ="k "> def</ span > < span class =" w " > </ span > < span class ="fm "> __init__</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> message</ span > < span class ="p "> ,</ span > < span class ="n "> detail</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ):</ span >
160150 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> message</ span > < span class ="o "> =</ span > < span class ="n "> message</ span >
161151 < span class ="k "> if</ span > < span class ="n "> detail</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="ow "> or</ span > < span class ="n "> detail</ span > < span class ="o "> ==</ span > < span class ="s2 "> ""</ span > < span class ="p "> :</ span >
162152 < span class ="n "> detail</ span > < span class ="o "> =</ span > < span class ="n "> _to_string</ span > < span class ="p "> (</ span > < span class ="n "> vips_lib</ span > < span class ="o "> .</ span > < span class ="n "> vips_error_buffer</ span > < span class ="p "> ())</ span >
@@ -165,12 +155,16 @@ <h1>Source code for pyvips.error</h1><div class="highlight"><pre>
165155
166156 < span class ="n "> logger</ span > < span class ="o "> .</ span > < span class ="n "> debug</ span > < span class ="p "> (</ span > < span class ="s1 "> 'Error </ span > < span class ="si "> %s</ span > < span class ="s1 "> </ span > < span class ="si "> %s</ span > < span class ="s1 "> '</ span > < span class ="p "> ,</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> message</ span > < span class ="p "> ,</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> detail</ span > < span class ="p "> )</ span >
167157
168- < span class ="k "> def</ span > < span class ="fm "> __str__</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ):</ span >
169- < span class ="k "> return</ span > < span class ="s1 "> '</ span > < span class ="si "> {0}</ span > < span class ="se "> \n</ span > < span class ="s1 "> </ span > < span class ="si "> {1}</ span > < span class ="s1 "> '</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> message</ span > < span class ="p "> ,</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> detail</ span > < span class ="p "> )</ span > </ div >
158+ < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="fm "> __str__</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ):</ span >
159+ < span class ="k "> return</ span > < span class ="sa "> f</ span > < span class ="s1 "> '</ span > < span class ="si "> {</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> message</ span > < span class ="si "> }</ span > < span class ="se "> \n</ span > < span class ="s1 "> </ span > < span class ="si "> {</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> detail</ span > < span class ="si "> }</ span > < span class ="s1 "> '</ span > </ div >
160+
170161
171162
172163< span class ="n "> __all__</ span > < span class ="o "> =</ span > < span class ="p "> [</ span >
173- < span class ="s1 "> '_to_bytes'</ span > < span class ="p "> ,</ span > < span class ="s1 "> '_to_string'</ span > < span class ="p "> ,</ span > < span class ="s1 "> '_to_string_copy'</ span > < span class ="p "> ,</ span > < span class ="s1 "> 'Error'</ span > < span class ="p "> ,</ span >
164+ < span class ="s1 "> '_to_bytes'</ span > < span class ="p "> ,</ span >
165+ < span class ="s1 "> '_to_string'</ span > < span class ="p "> ,</ span >
166+ < span class ="s1 "> '_to_string_copy'</ span > < span class ="p "> ,</ span >
167+ < span class ="s1 "> 'Error'</ span >
174168< span class ="p "> ]</ span >
175169</ pre > </ div >
176170
0 commit comments