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
|
"""Rendering renderer parameter handling."""
import typing
from . import base
__all__ = ['RENDERERS', 'verify_renderer', 'Renderer']
RENDERERS = {'cairo', # $ dot -T:
'dot',
'fig',
'gd',
'gdiplus',
'map',
'pic',
'pov',
'ps',
'svg',
'tk',
'vml',
'vrml',
'xdot'}
REQUIRED = False
def verify_renderer(renderer: typing.Optional[str], *,
required: bool = REQUIRED) -> None:
if renderer is None:
if required:
raise ValueError('missing renderer')
elif renderer.lower() not in RENDERERS:
raise ValueError(f'unknown renderer: {renderer!r}'
f' (must be None or one of {sorted(RENDERERS)})')
class Renderer(base.ParameterBase):
"""Rendering renderer parameter (no default)."""
_renderer = None
_verify_renderer = staticmethod(verify_renderer)
def __init__(self, *, renderer: typing.Optional[str] = None, **kwargs) -> None:
super().__init__(**kwargs)
self.renderer = renderer
def _copy_kwargs(self, **kwargs):
"""Return the kwargs to create a copy of the instance."""
renderer = self._getattr_from_dict('_renderer')
if renderer is not None:
kwargs['renderer'] = renderer
return super()._copy_kwargs(**kwargs)
@property
def renderer(self) -> typing.Optional[str]:
"""The output renderer used for rendering
(``'cairo'``, ``'gd'``, ...)."""
return self._renderer
@renderer.setter
def renderer(self, renderer: typing.Optional[str]) -> None:
if renderer is None:
self.__dict__.pop('_renderer', None)
else:
renderer = renderer.lower()
self._verify_renderer(renderer)
self._renderer = renderer
|