-
-
Notifications
You must be signed in to change notification settings - Fork 504
/
image.py
550 lines (444 loc) · 17.7 KB
/
image.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
"""
Contains Image panes including renderers for PNG, SVG, GIF and JPG
file types.
"""
from __future__ import annotations
import asyncio
import base64
import struct
from io import BytesIO
from pathlib import PurePath
from typing import (
TYPE_CHECKING, Any, ClassVar, Dict, List, Mapping, Tuple,
)
import param
from ..models import PDF as _BkPDF
from ..util import isfile, isurl
from .markup import HTMLBasePane, escape
if TYPE_CHECKING:
from bokeh.model import Model
_tasks = set()
class FileBase(HTMLBasePane):
embed = param.Boolean(default=False, doc="""
Whether to embed the file as base64.""")
filetype: ClassVar[str]
_extensions: ClassVar[None | Tuple[str, ...]] = None
_rename: ClassVar[Mapping[str, str | None]] = {'embed': None}
_rerender_params: ClassVar[List[str]] = [
'embed', 'object', 'styles', 'width', 'height'
]
__abstract = True
def __init__(self, object=None, **params):
if isinstance(object, PurePath):
object = str(object)
super().__init__(object=object, **params)
def _type_error(self, object):
if isinstance(object, str):
raise ValueError(
f"{type(self).__name__} pane cannot parse string that "
f"is not a filename or URL ({object!r})."
)
super()._type_error(object)
@classmethod
def applies(cls, obj: Any) -> float | bool | None:
filetype = cls.filetype.split('+')[0]
exts = cls._extensions or (filetype,)
if hasattr(obj, f'_repr_{filetype}_'):
return 0.15
if isinstance(obj, PurePath):
obj = str(obj.absolute())
if isinstance(obj, str):
if isurl(obj, exts):
return True
elif any(obj.lower().endswith(f'.{ext}') for ext in exts):
return True
elif isurl(obj, None):
return 0.0
elif isinstance(obj, bytes):
try:
cls._imgshape(obj)
return True
except Exception:
return False
if hasattr(obj, 'read'): # Check for file like object
return True
return False
def _b64(self, data: str | bytes) -> str:
if not isinstance(data, bytes):
data = data.encode('utf-8')
b64 = base64.b64encode(data).decode("utf-8")
return f"data:image/{self.filetype};base64,{b64}"
def _data(self, obj: Any) -> bytes | None:
filetype = self.filetype.split('+')[0]
if hasattr(obj, f'_repr_{filetype}_'):
return getattr(obj, f'_repr_{filetype}_')()
elif isinstance(obj, (str, PurePath)):
if isfile(obj):
with open(obj, 'rb') as f:
return f.read()
elif isinstance(obj, bytes):
return obj
elif hasattr(obj, 'read'):
if hasattr(obj, 'seek'):
obj.seek(0)
return obj.read()
elif not isurl(obj, None):
return None
from ..io.state import state
if state._is_pyodide:
from ..io.pyodide import _IN_WORKER, fetch_binary
if _IN_WORKER:
return fetch_binary(obj).read()
else:
from pyodide.http import pyfetch
async def replace_content():
self.object = await (await pyfetch(obj)).bytes()
task = asyncio.create_task(replace_content())
_tasks.add(task)
task.add_done_callback(_tasks.discard)
else:
import requests
r = requests.request(url=obj, method='GET')
return r.content
class ImageBase(FileBase):
"""
Encodes an image as base64 and wraps it in a Bokeh Div model.
This is an abstract base class that needs the image type
to be specified and specific code for determining the image shape.
The filetype determines the filetype, extension, and MIME type for
this image. Each image type (png,jpg,gif) has a base class that
supports anything with a `_repr_X_` method (where X is `png`,
`gif`, etc.), a local file with the given file extension, or a
HTTP(S) url with the given extension. Subclasses of each type can
provide their own way of obtaining or generating a PNG.
"""
alt_text = param.String(default=None, doc="""
alt text to add to the image tag. The alt text is shown when a
user cannot load or display the image.""")
caption = param.String(default=None, doc="""
Optional caption for the image.""")
fixed_aspect = param.Boolean(default=True, doc="""
Whether the aspect ratio of the image should be forced to be
equal.""")
link_url = param.String(default=None, doc="""
A link URL to make the image clickable and link to some other
website.""")
_rerender_params: ClassVar[List[str]] = [
'alt_text', 'caption', 'link_url', 'embed', 'object', 'styles', 'width', 'height'
]
_rename: ClassVar[Mapping[str, str | None ]] = {
'alt_text': None, 'fixed_aspect': None, 'link_url': None, 'caption': None,
}
_target_transforms: ClassVar[Mapping[str, str | None]] = {
'object': """'<img src="' + value + '"></img>'"""
}
__abstract = True
@classmethod
def _imgshape(cls, data):
"""Calculate and return image width,height"""
raise NotImplementedError
def _format_html(
self, src: str, width: str | None = None, height: str | None = None
):
alt = f'alt={self.alt_text!r}' if self.alt_text else ''
width = f' width: {width};' if width else ''
height = f' height: {height};' if height else ''
object_fit = "contain" if self.fixed_aspect else "fill"
html = f'<img src="{src}" {alt} style="max-width: 100%; max-height: 100%; object-fit: {object_fit};{width}{height}"></img>'
if self.link_url:
html = f'<a href="{self.link_url}" target="_blank">{html}</a>'
if self.caption:
html = f'<figure>{html}<figcaption>{self.caption}</figcaption></figure>'
return escape(html)
def _img_dims(self, width, height):
smode = self.sizing_mode
if smode in ['fixed', None]:
w, h = (
(f'{width}px' if width else 'auto'),
(f'{height}px' if height else 'auto')
)
elif smode == 'stretch_both' and not self.fixed_aspect:
w, h = '100%', '100%'
elif smode == 'stretch_width' and not self.fixed_aspect:
w, h = '100%', (f'{height}px' if height else 'auto')
elif smode == 'stretch_height' and not self.fixed_aspect:
w, h = (f'{width}px' if width else 'auto'), '100%'
elif smode in ('scale_height', 'stretch_height'):
w, h = 'auto', '100%'
else:
w, h = '100%', 'auto'
return w, h
def _transform_object(self, obj: Any) -> Dict[str, Any]:
if self.embed or (isfile(obj) or not isinstance(obj, (str, PurePath))):
data = self._data(obj)
else:
w, h = self._img_dims(self.width, self.height)
return dict(object=self._format_html(obj, w, h))
if data is None:
return dict(object='<img></img>')
if not isinstance(data, bytes):
data = base64.b64decode(data)
width, height = self._imgshape(data)
if self.width is not None:
if self.height is None:
height = int((self.width/width)*height)
else:
height = self.height
width = self.width
elif self.height is not None:
width = int((self.height/height)*width)
height = self.height
src = self._b64(data)
w, h = self._img_dims(width, height)
html = self._format_html(src, w, h)
return dict(width=width, height=height, object=html)
class Image(ImageBase):
"""
The `Image` pane embeds any known image format in a panel if
provided a local path, bytes or remote image link.
:Example:
>>> Image(
... 'https://panel.holoviz.org/_static/logo_horizontal.png',
... alt_text='The Panel Logo',
... link_url='https://panel.holoviz.org/index.html',
... width=500
... )
"""
@classmethod
def applies(cls, obj: Any) -> float | bool | None:
precedences = []
for img_cls in param.concrete_descendents(ImageBase).values():
if img_cls is Image:
continue
applies = img_cls.applies(obj)
if isinstance(applies, bool) and applies:
return applies
elif isinstance(applies, (float, int)):
precedences.append(applies)
if precedences:
return sorted(precedences)[-1]
return False
def _transform_object(self, obj: Any) -> Dict[str, Any]:
params = {
k: v for k, v in self.param.values().items()
if k not in ('name', 'object')
}
for img_cls in param.concrete_descendents(ImageBase).values():
if img_cls is not Image and img_cls.applies(obj):
return img_cls(obj, **params)._transform_object(obj)
return {'object': '<img></img>'}
class PNG(ImageBase):
"""
The `PNG` pane embeds a .png image file in a panel if provided a local
path, or will link to a remote image if provided a URL.
Reference: https://panel.holoviz.org/reference/panes/PNG.html
:Example:
>>> PNG(
... 'https://panel.holoviz.org/_static/logo_horizontal.png',
... alt_text='The Panel Logo',
... link_url='https://panel.holoviz.org/index.html',
... width=500
... )
"""
filetype: ClassVar[str] = 'png'
@classmethod
def _imgshape(cls, data):
import struct
w, h = struct.unpack('>LL', data[16:24])
return int(w), int(h)
class GIF(ImageBase):
"""
The `GIF` pane embeds a .gif image file in a panel if provided a local
path, or will link to a remote image if provided a URL.
Reference: https://panel.holoviz.org/reference/panes/GIF.html
:Example:
>>> GIF(
... 'https://upload.wikimedia.org/wikipedia/commons/b/b1/Loading_icon.gif',
... alt_text='A loading spinner',
... link_url='https://commons.wikimedia.org/wiki/File:Loading_icon.gif',
... width=500
... )
"""
filetype: ClassVar[str] = 'gif'
@classmethod
def _imgshape(cls, data):
import struct
w, h = struct.unpack("<HH", data[6:10])
return int(w), int(h)
class ICO(ImageBase):
"""
The `ICO` pane embeds an .ico image file in a panel if provided a local
path, or will link to a remote image if provided a URL.
Reference: https://panel.holoviz.org/reference/panes/ICO.html
:Example:
>>> ICO(
... some_url,
... alt_text='An .ico file',
... link_url='https://en.wikipedia.org/wiki/ICO_(file_format)',
... width=50
...
"""
filetype: ClassVar[str] = 'ico'
@classmethod
def _imgshape(cls, data):
import struct
w, h = struct.unpack("<BB" , data[6:8])
return int(w or 256), int(h or 256)
class JPG(ImageBase):
"""
The `JPG` pane embeds a .jpg or .jpeg image file in a panel if
provided a local path, or will link to a remote image if provided
a URL.
Reference: https://panel.holoviz.org/reference/panes/JPG.html
:Example:
>>> JPG(
... 'https://www.gstatic.com/webp/gallery/4.sm.jpg',
... alt_text='A nice tree',
... link_url='https://en.wikipedia.org/wiki/JPEG',
... width=500
... )
"""
filetype: ClassVar[str] = 'jpeg'
_extensions: ClassVar[Tuple[str, ...]] = ('jpeg', 'jpg')
@classmethod
def _imgshape(cls, data):
import struct
b = BytesIO(data)
b.read(2)
c = b.read(1)
while (c and ord(c) != 0xDA):
while (ord(c) != 0xFF): c = b.read(1)
while (ord(c) == 0xFF): c = b.read(1)
if (ord(c) >= 0xC0 and ord(c) <= 0xC3):
b.read(3)
h, w = struct.unpack(">HH", b.read(4))
break
else:
b.read(int(struct.unpack(">H", b.read(2))[0])-2)
c = b.read(1)
return int(w), int(h)
class SVG(ImageBase):
"""
The `SVG` pane embeds a .svg image file in a panel if provided a
local path, or will link to a remote image if provided a URL.
Reference: https://panel.holoviz.org/reference/panes/SVG.html
:Example:
>>> SVG(
... 'https://upload.wikimedia.org/wikipedia/commons/6/6b/Bitmap_VS_SVG.svg',
... alt_text='A gif vs svg comparison',
... link_url='https://en.wikipedia.org/wiki/SVG',
... width=300, height=400
... )
"""
encode = param.Boolean(default=True, doc="""
Whether to enable base64 encoding of the SVG, base64 encoded
SVGs do not support links.""")
filetype: ClassVar[str] = 'svg+xml'
_rename: ClassVar[Mapping[str, str | None]] = {'encode': None}
_rerender_params: ClassVar[List[str]] = ImageBase._rerender_params + ['encode']
@classmethod
def applies(cls, obj: Any) -> float | bool | None:
return (super().applies(obj) or
(isinstance(obj, str) and obj.lstrip().startswith('<svg')))
def _type_error(self, object):
if isinstance(object, str):
raise ValueError("%s pane cannot parse string that is not a filename, "
"URL or a SVG XML contents." % type(self).__name__)
super()._type_error(object)
def _data(self, obj):
if (isinstance(obj, str) and obj.lstrip().startswith('<svg')):
return obj
return super()._data(obj)
def _imgshape(self, data):
return (self.width, self.height)
def _transform_object(self, obj: Any) -> Dict[str, Any]:
width, height = self.width, self.height
w, h = self._img_dims(width, height)
if self.embed or (isfile(obj) or (isinstance(obj, str) and obj.lstrip().startswith('<svg'))
or not isinstance(obj, (str, PurePath))):
data = self._data(obj)
else:
return dict(object=self._format_html(obj, w, h))
if data is None:
return dict(object='<img></img>')
if self.encode:
ws = f' width: {w};' if w else ''
hs = f' height: {h};' if h else ''
object_fit = "contain" if self.fixed_aspect else "fill"
data = f'<img src="{self._b64(data)}" style="max-width: 100%; max-height: 100%; object-fit: {object_fit};{ws}{hs}"></img>'
if isinstance(data, bytes):
data = data.decode('utf-8')
return dict(width=width, height=height, text=escape(data))
class PDF(FileBase):
"""
The `PDF` pane embeds a .pdf image file in a panel if provided a
local path, or will link to a remote image if provided a URL.
Reference: https://panel.holoviz.org/reference/panes/PDF.html
:Example:
>>> PDF(
... 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf',
... width=300, height=410
... )
"""
start_page = param.Integer(default=1, doc="""
Start page of the pdf, by default the first page.""")
filetype: ClassVar[str] = 'pdf'
_bokeh_model: ClassVar[Model] = _BkPDF
_rename: ClassVar[Mapping[str, str | None]] = {'embed': 'embed'}
_rerender_params: ClassVar[List[str]] = FileBase._rerender_params + ['start_page']
def _transform_object(self, obj: Any) -> Dict[str, Any]:
if obj is None:
return dict(object='<embed></embed>')
elif self.embed or not isurl(obj):
# This is handled by the Typescript Bokeh model to be able to render large PDF files (>2MB).
data = self._data(obj)
if not isinstance(data, bytes):
data = data.encode('utf-8')
b64 = base64.b64encode(data).decode("utf-8")
if self.embed:
return dict(text=b64)
obj = f'data:application/pdf;base64,{b64}'
w, h = self.width or '100%', self.height or '100%'
page = f'#page={self.start_page}' if getattr(self, 'start_page', None) else ''
html = f'<embed src="{obj}{page}" width={w!r} height={h!r} type="application/pdf">'
return dict(text=escape(html))
class WebP(ImageBase):
"""
The `WebP` pane embeds a .webp image file in a panel if
provided a local path, or will link to a remote image if provided
a URL.
Reference: https://panel.holoviz.org/reference/panes/WebP.html
:Example:
>>> WebP(
... 'https://assets.holoviz.org/panel/samples/webp_sample.webp',
... alt_text='A nice tree',
... link_url='https://en.wikipedia.org/wiki/WebP',
... width=500,
... caption='A nice tree'
... )
"""
filetype: ClassVar[str] = 'webp'
_extensions: ClassVar[Tuple[str, ...]] = ('webp',)
@classmethod
def _imgshape(cls, data):
with BytesIO(data) as b:
b.read(12) # Skip RIFF header
chunk_header = b.read(4).decode('utf-8')
if chunk_header[:3] != 'VP8':
raise ValueError("Invalid WebP file")
wptype = chunk_header[3]
b.read(4)
if wptype == 'X':
b.read(4)
w = int.from_bytes(b.read(3), 'little') + 1
h = int.from_bytes(b.read(3), 'little') + 1
elif wptype == 'L':
b.read(1)
bits = struct.unpack("<I", b.read(4))[0]
w = (bits & 0x3FFF) + 1
h = ((bits >> 14) & 0x3FFF) + 1
elif wptype == ' ':
b.read(6)
w = int.from_bytes(b.read(2), 'little') + 1
h = int.from_bytes(b.read(2), 'little') + 1
return int(w), int(h)