pip._vendor.pygments.formatters.svg.SvgFormatter Class Reference

Inheritance diagram for pip._vendor.pygments.formatters.svg.SvgFormatter:

Collaboration diagram for pip._vendor.pygments.formatters.svg.SvgFormatter:

Public Member Functions
	__init__ (self, **options)
	format_unencoded (self, tokensource, outfile)
Public Member Functions inherited from pip._vendor.pygments.formatter.Formatter
	get_style_defs (self, arg='')
	format (self, tokensource, outfile)

Public Attributes
	nowrap
	fontfamily
	fontsize
	xoffset
	yoffset
	ystep
	spacehack
	linenos
	linenostart
	linenostep
	linenowidth
	encoding
Public Attributes inherited from pip._vendor.pygments.formatter.Formatter
	style
	full
	title
	encoding
	options

Static Public Attributes
str	name = 'SVG'
list	aliases = ['svg']
list	filenames = ['*.svg']
Static Public Attributes inherited from pip._vendor.pygments.formatter.Formatter
	name = None
list	aliases = []
list	filenames = []
bool	unicodeoutput = True

Protected Member Functions
	_get_style (self, tokentype)

Protected Attributes
	_stylecache

Detailed Description

Format tokens as an SVG graphics file.  This formatter is still experimental.
Each line of code is a ``<text>`` element with explicit ``x`` and ``y``
coordinates containing ``<tspan>`` elements with the individual token styles.

By default, this formatter outputs a full SVG document including doctype
declaration and the ``<svg>`` root element.

.. versionadded:: 0.9

Additional options accepted:

`nowrap`
    Don't wrap the SVG ``<text>`` elements in ``<svg><g>`` elements and
    don't add a XML declaration and a doctype.  If true, the `fontfamily`
    and `fontsize` options are ignored.  Defaults to ``False``.

`fontfamily`
    The value to give the wrapping ``<g>`` element's ``font-family``
    attribute, defaults to ``"monospace"``.

`fontsize`
    The value to give the wrapping ``<g>`` element's ``font-size``
    attribute, defaults to ``"14px"``.

`linenos`
    If ``True``, add line numbers (default: ``False``).

`linenostart`
    The line number for the first line (default: ``1``).

`linenostep`
    If set to a number n > 1, only every nth line number is printed.
    
`linenowidth`
    Maximum width devoted to line numbers (default: ``3*ystep``, sufficient
    for up to 4-digit line numbers. Increase width for longer code blocks).  
    
`xoffset`
    Starting offset in X direction, defaults to ``0``.

`yoffset`
    Starting offset in Y direction, defaults to the font size if it is given
    in pixels, or ``20`` else.  (This is necessary since text coordinates
    refer to the text baseline, not the top edge.)

`ystep`
    Offset to add to the Y coordinate for each subsequent line.  This should
    roughly be the text size plus 5.  It defaults to that value if the text
    size is given in pixels, or ``25`` else.

`spacehack`
    Convert spaces in the source to ``&#160;``, which are non-breaking
    spaces.  SVG provides the ``xml:space`` attribute to control how
    whitespace inside tags is handled, in theory, the ``preserve`` value
    could be used to keep all whitespace as-is.  However, many current SVG
    viewers don't obey that rule, so this option is provided as a workaround
    and defaults to ``True``.

Constructor & Destructor Documentation

__init__()

pip._vendor.pygments.formatters.svg.SvgFormatter.__init__	(		self,
		**	options
	)

As with lexers, this constructor takes arbitrary optional arguments,
and if you override it, you should first process your own options, then
call the base class implementation.

Reimplemented from pip._vendor.pygments.formatter.Formatter.

Member Function Documentation

format_unencoded()

pip._vendor.pygments.formatters.svg.SvgFormatter.format_unencoded	(		self,
			tokensource,
			outfile
	)

Format ``tokensource``, an iterable of ``(tokentype, tokenstring)``
tuples and write it into ``outfile``.

For our implementation we put all lines in their own 'line group'.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/pygments/formatters/svg.py