pyglet.text

Submodules

Details

Text formatting, layout and display.

This module provides classes for loading styled documents from text files, HTML files and a pyglet-specific markup format. Documents can be styled with multiple fonts, colours, styles, text sizes, margins, paragraph alignments, and so on.

Using the layout classes, documents can be laid out on a single line or word-wrapped to fit a rectangle. A layout can then be efficiently drawn in a window or updated incrementally (for example, to support interactive text editing).

The label classes provide a simple interface for the common case where an application simply needs to display some text in a window.

A plain text label can be created with:

label = pyglet.text.Label('Hello, world',
                          font_name='Times New Roman',
                          font_size=36,
                          x=10, y=10)

Alternatively, a styled text label using HTML can be created with:

label = pyglet.text.HTMLLabel('<b>Hello</b>, <i>world</i>',
                              x=10, y=10)

Either label can then be drawn at any time with:

label.draw()

For details on the subset of HTML supported, see pyglet.text.formats.html.

Refer to the Programming Guide for advanced usage of the document and layout classes, including interactive editing, embedding objects within documents and creating scrollable layouts.

class Weight

An Enum of known cross-platform font weight strings.

Each value is both an Enum and a str. This is not a built-in Python StrEnum to ensure compatibility with Python < 3.11.

Important

Fonts will use the closest match if they lack a weight!

The values of this enum imitate the string names for font weights as used in CSS and the OpenType specification. Numerical font weights are not supported because:

Integer font weight support and behavior varies by back-end
Some font renderers do not support or round float values
Some font renderers lack support for variable-width fonts

Additional weight strings may be supported by certain font-rendering back-ends. To learn more, please see your platform’s API documentation and the following:

THIN = 'thin'

EXTRALIGHT = 'extralight'

LIGHT = 'light'

NORMAL = 'normal': The default weight for a font.

MEDIUM = 'medium'

SEMIBOLD = 'semibold'

BOLD = 'bold': The default bold style for a font.

EXTRABOLD = 'extrabold'

ULTRABOLD = 'ultrabold'

__new__(value)

exception DocumentDecodeException: An error occurred decoding document text.

class DocumentDecoder

Abstract document decoder.

abstract decode( text: str, location: Location | None = None, ) → AbstractDocument

Decode document text.

Parameters:

text (str) – Text to decode
location (Location | None) – Location to use as base path for additional resources referenced within the document (for example, HTML images).

Return type:

AbstractDocument

class DocumentLabel

Base label class.

A label is a layout that exposes convenience methods for manipulating the associated document.

__init__( document: AbstractDocument, x: float = 0.0, y: float = 0.0, z: float = 0.0, width: int | None = None, height: int | None = None, anchor_x: Literal['left', 'center', 'right'] = 'left', anchor_y: Literal['top', 'bottom', 'center', 'baseline'] = 'baseline', rotation: float = 0.0, multiline: bool = False, dpi: int | None = None, batch: Batch | None = None, group: Group | None = None, program: ShaderProgram | None = None, init_document: bool = True, ) → None

Create a label for a given document.

Parameters:

document (AbstractDocument) – Document to attach to the layout.
x (float) – X coordinate of the label.
y (float) – Y coordinate of the label.
z (float) – Z coordinate of the label.
width (int | None) – Width of the label in pixels, or None
height (int | None) – Height of the label in pixels, or None
anchor_x (Literal['left', 'center', 'right']) – Anchor point of the X coordinate: one of "left", “center”` or "right".
anchor_y (Literal['top', 'bottom', 'center', 'baseline']) – Anchor point of the Y coordinate: one of "bottom", "baseline", "center" or "top".
rotation (float) – The amount to rotate the label in degrees. A positive amount will be a clockwise rotation, negative values will result in counter-clockwise rotation.
multiline (bool) – If True, the label will be word-wrapped and accept newline characters. You must also set the width of the label.
dpi (int | None) – Resolution of the fonts in this layout. Defaults to 96.
batch (Batch | None) – Optional graphics batch to add the label to.
group (Group | None) – Optional graphics group to use.
program (ShaderProgram | None) – Optional graphics shader to use. Will affect all glyphs.
init_document (bool) – If True, the document will be initialized. If you are passing an already-initialized document, then you can avoid duplicating work by setting this to False.

get_style(name: str) → Any

Get a document style value by name.

If the document has more than one value of the named style, pyglet.text.document.STYLE_INDETERMINATE is returned.

Parameters:: name (str) – Style name to query. See documentation from pyglet.text.layout for known style names.
Return type:: Any

set_style(name: str, value: Any) → None

Set a document style value by name over the whole document.

Parameters:

name (str) – Name of the style to set. See documentation for pyglet.text.layout for known style names.
value (Any) – Value of the style.

Return type:

None

property color: tuple[int, int, int, int]

Text color.

Color is a 4-tuple of RGBA components, each in range [0, 255].

property font_name: str | list[str]

Font family name.

The font name, as passed to pyglet.font.load(). A list of names can optionally be given: the first matching font will be used.

property font_size: float: Font size, in points.

property italic: bool | str: Italic font style.

property opacity: int

Blend opacity.

This property sets the alpha component of the colour of the label’s vertices. With the default blend mode, this allows the layout to be drawn with fractional opacity, blending with the background.

An opacity of 255 (the default) has no effect. An opacity of 128 will make the label appear semi-translucent.

property text: str: The text of the label.

property weight: str

The font weight (boldness or thickness), as a string.

See the Weight enum for valid cross-platform string values.

class HTMLLabel

HTML formatted text label.

A subset of HTML 4.01 is supported. See pyglet.text.formats.html for details.

__init__( text: str = '', x: float = 0.0, y: float = 0.0, z: float = 0.0, width: int | None = None, height: int | None = None, anchor_x: Literal['left', 'center', 'right'] = 'left', anchor_y: Literal['top', 'bottom', 'center', 'baseline'] = 'baseline', rotation: float = 0.0, multiline: bool = False, dpi: float | None = None, location: Location | None = None, batch: Batch | None = None, group: Group | None = None, program: ShaderProgram | None = None, ) → None

Create a label with an HTML string.

Parameters:

text (str) – Text to display.
x (float) – X coordinate of the label.
y (float) – Y coordinate of the label.
z (float) – Z coordinate of the label.
width (int | None) – Width of the label in pixels, or None
height (int | None) – Height of the label in pixels, or None
anchor_x (Literal['left', 'center', 'right']) – Anchor point of the X coordinate: one of "left", "center" or "right".
anchor_y (Literal['top', 'bottom', 'center', 'baseline']) – Anchor point of the Y coordinate: one of "bottom", "baseline", "center" or "top".
rotation (float) – The amount to rotate the label in degrees. A positive amount will be a clockwise rotation, negative values will result in counter-clockwise rotation.
multiline (bool) – If True, the label will be word-wrapped and accept newline characters. You must also set the width of the label.
dpi (float | None) – Resolution of the fonts in this layout. Defaults to 96.
location (Location | None) – Location object for loading images referred to in the document. By default, the working directory is used.
batch (Batch | None) – Optional graphics batch to add the label to.
group (Group | None) – Optional graphics group to use.
program (ShaderProgram | None) – Optional graphics shader to use. Will affect all glyphs.

property text: str: HTML formatted text of the label.

class Label

Plain text label.

__init__( text: str = '', x: float = 0.0, y: float = 0.0, z: float = 0.0, width: int | None = None, height: int | None = None, anchor_x: Literal['left', 'center', 'right'] = 'left', anchor_y: Literal['top', 'bottom', 'center', 'baseline'] = 'baseline', rotation: float = 0.0, multiline: bool = False, dpi: int | None = None, font_name: str | None = None, font_size: float | None = None, weight: str = 'normal', italic: bool | str = False, stretch: bool | str = False, color: tuple[int, int, int, int] | tuple[int, int, int] = (255, 255, 255, 255), align: Literal['bottom', 'center', 'top'] = 'left', batch: Batch | None = None, group: Group | None = None, program: ShaderProgram | None = None, ) → None

Create a plain text label.

Parameters:

text (str) – Text to display.
x (float) – X coordinate of the label.
y (float) – Y coordinate of the label.
z (float) – Z coordinate of the label.
width (int | None) – Width of the label in pixels, or None
height (int | None) – Height of the label in pixels, or None
anchor_x (Literal['left', 'center', 'right']) – Anchor point of the X coordinate: one of "left", "center" or "right".
anchor_y (Literal['top', 'bottom', 'center', 'baseline']) – Anchor point of the Y coordinate: one of "bottom", "baseline", "center" or "top".
rotation (float) – The amount to rotate the label in degrees. A positive amount will be a clockwise rotation, negative values will result in counter-clockwise rotation.
multiline (bool) – If True, the label will be word-wrapped and accept newline characters. You must also set the width of the label.
dpi (int | None) – Resolution of the fonts in this layout. Defaults to 96.
font_name (str | None) – Font family name(s). If more than one name is given, the first matching name is used.
font_size (float | None) – Font size, in points.
weight (str) – The ‘weight’ of the font (boldness). See the Weight enum for valid cross-platform weight names.
italic (bool | str) – Italic font style.
stretch (bool | str) – Stretch font style.
color (tuple[int, int, int, int] | tuple[int, int, int]) – Font color as RGBA or RGB components, each within 0 <= component <= 255.
align (Literal['bottom', 'center', 'top']) – Horizontal alignment of text on a line, only applies if a width is supplied. One of "left", "center" or "right".
batch (Batch | None) – Optional graphics batch to add the label to.
group (Group | None) – Optional graphics group to use.
program (ShaderProgram | None) – Optional graphics shader to use. Will affect all glyphs.

decode_attributed(text: str) → FormattedDocument

Create a document directly from some attributed text.

See pyglet.text.formats.attributed for a description of attributed text.

Return type:: FormattedDocument

decode_html( text: str, location: str | None = None, ) → FormattedDocument

Create a document directly from some HTML formatted text.

Parameters:

text (str) – HTML data to decode.
location (str | None) – Location giving the base path for additional resources referenced from the document (e.g., images).

Return type:

FormattedDocument

decode_text(text: str) → UnformattedDocument

Create a document directly from some plain text.

Return type:: UnformattedDocument

get_decoder( filename: str | None, mimetype: Literal['text/plain', 'text/html', 'text/vnd.pyglet-attributed'] | None = None, ) → DocumentDecoder

Get a document decoder for the given filename and MIME type.

If mimetype is omitted it is guessed from the filename extension.

The following MIME types are supported:

text/plain: Plain text
text/html: HTML 4 Transitional
text/vnd.pyglet-attributed: Attributed text; see pyglet.text.formats.attributed

Parameters:

filename (str | None) – Filename to guess the MIME type from. If a MIME type is given, the filename is ignored.
mimetype (Literal['text/plain', 'text/html', 'text/vnd.pyglet-attributed'] | None) – MIME type to lookup, or None to guess the type from the filename.

Raises:

DocumentDecodeException – If MIME type is not from the supported types.

Return type:

DocumentDecoder

load( filename: str, file: BinaryIO | None = None, mimetype: Literal['text/plain', 'text/html', 'text/vnd.pyglet-attributed'] | None = None, ) → AbstractDocument

Load a document from a file.

Parameters:

filename (str) – Filename of document to load.
file (BinaryIO | None) – File object containing encoded data. If omitted, filename is loaded from disk.
mimetype (Literal['text/plain', 'text/html', 'text/vnd.pyglet-attributed'] | None) – MIME type of the document. If omitted, the filename extension is used to guess a MIME type. See get_decoder for a list of supported MIME types.

Return type:

AbstractDocument