Aspose.Font FOSS for Python

API reference for Aspose.Font FOSS for Python v1.0.0. 139 public types organized by module.

Core API

Class	Description
`ActiveTupleSummary`	ActiveTupleSummary.to_dict() returns a dictionary containing the tuple’s index, scalar value, peak coordinates, start coordinates, and end coordinates.
`AnimationAsset`	AnimationAsset.write_to(path) writes the generated animation data to the given filesystem location, creates missing parent directories, and returns the Path of the written file.
`AnimationFramePackage`	AnimationFramePackage.write_to(path) writes the storyboard image, each frame image, and a JSON manifest describing fps and frame labels to the specified directory.
`AnimationPreset`	AnimationPreset.name stores the identifier of the animation preset.
`AnimationPreviewBuilder`	AnimationPreviewBuilder.available_presets returns a tuple of preset names for animation generation.
`AnimationReviewPackage`	AnimationReviewPackage.write_to saves the review package to the given filesystem path and returns the Path.
`AnimationShowcasePackage`	AnimationShowcasePackage.write_to writes the package to the given path and returns the resulting Path.
`AnimationStep`	AnimationStep.coordinates stores a mapping of axis names to float values defining the font instance.
`BinaryReader`	Wraps a byte source in seekable BytesIO for big-endian font binary parsing.
`BinaryWriter`	Accumulates bytes for binary font serialization.
`CffSerializer`	CffSerializer can serialize a fully populated CffFont into a byte array suitable for writing out as a CFF or OpenType font file.
`ClosePath`	Class extending PathCommand.
`CompatibilityChecker`	CompatibilityChecker.compare_fonts(before, after, before_label, after_label, codepoints, text) produces a CompatibilityReport that can be exported to JSON via report.to_json(indent=2, sort_keys=True).
`CompatibilityReport`	CompatibilityReport.to_json(indent, sort_keys) returns a JSON string of the report, and write_json(target, indent, sort_keys) writes that JSON directly to a file.
`CompletedTaskRecord`	CompletedTaskRecord.task_id uniquely identifies the completed task.
`CompositeComponentMovement`	CompositeComponentMovement.to_dict returns a dict of the object’s numeric and boolean fields.
`CompositeGlyphComponent`	CompositeGlyphComponent.to_dict() returns a dict of the component’s numeric attributes.
`CoverageGroup`	Coverage diagnostics for one request source such as a preset, text, or range.
`CurveAdapter`	CurveAdapter.quad_to_cubic converts a quadratic Bézier (p0, q, p3) to an equivalent cubic Bézier, returning four points.
`CurveTo`	CurveTo.x1 is the x‑coordinate of the first Bézier control point.
`DeltaInspector`	DeltaInspector enables detailed variable‑font delta analysis, generating GlyphDeltaReport and TextDeltaReport objects that highlight coordinate changes across instances.
`DeltaPoint`	DeltaPoint.to_dict returns a dictionary of the point’s numeric components.
`DeltaTupleReport`	DeltaTupleReport.tuple_index is the zero‑based index of the delta tuple.
`EotSerializer`	EotSerializer.serialize(font) returns the complete binary representation of an EOT font ready for file output.
`FamilyReviewExportPackage`	FamilyReviewExportPackage.write_to(directory) creates a set of HTML, CSS, and manifest files for a font family, returning the list of generated file paths.
`Font`	Abstract base for all font format implementations.
`FontCleaner`	Font metadata and technical table cleaner.
`FontConversionException`	Raised when font format conversion fails or is not supported.
`FontConverter`	FontConverter.convert(font, target) produces a new Font object in the target format, raising FontConversionException if the conversion cannot be performed.
`FontEncoding`	Maps Unicode codepoints to glyph IDs.
`FontException`	Base class for all font library exceptions.
`FontLoader`	FontLoader.open(source, font_type, collection_index) returns a Font object representing the requested font type without fully loading the entire file into memory.
`FontMetrics`	FontMetrics exposes key typographic values such as units_per_em, ascender, descender, and line_gap for layout calculations.
`FontNotSupportedException`	Raised for valid but unsupported font features (e.g.
`FontParseException`	Raised when binary font data cannot be parsed.
`FontPreviewBuilder`	FontPreviewBuilder.build(font, text, size, color, background, padding, antialias, file_stem, instance_coordinates, instance_name, output_format) generates a PreviewImage (PNG or SVG) of the supplied text rendered with the given font.
`FontSourceInfo`	Describe the origin of loaded bytes.
`FontSubsetter`	FontSubsetter.available_presets() returns a tuple of preset names that can be used for web‑oriented subsetting.
`Glyph`	Glyph.glyph_id identifies the glyph using its numeric GlyphId.
`GlyphAccessor`	Retrieves glyphs by ID or Unicode codepoint.
`GlyphCompatibilityIssue`	GlyphCompatibilityIssue.to_dict returns a dictionary representation of the issue.
`GlyphDeltaComparisonReport`	GlyphDeltaComparisonReport.moved_point_count is the count of points that moved between before and after.
`GlyphDeltaReport`	GlyphDeltaReport.to_dict returns a dictionary representation of the report’s data.
`GlyphId`	GlyphId.value holds the integer identifier of a glyph.
`GlyphInterpolationIssue`	GlyphInterpolationIssue.codepoint is the integer Unicode codepoint of the affected glyph.
`GlyphLayout`	A single glyph positioned in world-space layout coordinates.
`GlyphNotFoundException`	Raised when a requested glyph ID or codepoint has no mapping in the font.
`GlyphOutlineStats`	GlyphOutlineStats.to_dict returns a dictionary representation of the outline statistics.
`GlyphPath`	Ordered sequence of PathCommand objects representing one glyph’s outline.
`KernPair`	KernPair.left is the GlyphId of the left glyph in the kerning pair.
`LanguageProfile`	LanguageProfile.to_dict returns a dictionary representation of the language profile.
`LineTo`	LineTo.x represents the horizontal coordinate of the line endpoint.
`LoadedFont`	Friendly loader result that wraps a font plus source metadata.
`LocalizationCoverage`	LocalizationCoverage.to_dict returns a dictionary representation of the coverage data.
`LocalizationResolution`	LocalizationResolution.to_dict returns a dictionary representation of the resolution state.
`MoveTo`	MoveTo.x stores the horizontal coordinate for the move operation.
`PathCommand`	Abstract marker for all path command types.
`PreviewImage`	PreviewImage.write_to(path) saves the generated PNG or SVG preview to the specified filesystem location and returns the Path object.
`QuadraticTo`	QuadraticTo.x1 represents the x‑coordinate of the quadratic Bézier control point.
`Rasterizer`	Scanline rasterizer for GlyphPath outlines with pure-Python PNG export.
`RequestedLanguageHint`	RequestedLanguageHint.to_dict returns a dictionary representation of the hint object.
`ResolvedInstance`	ResolvedInstance.label is the human‑readable name of the resolved instance.
`SmartInstancer`	SmartInstancer.instantiate(coordinates, instance_name, naming_strategy, family_suffix, legacy_family_name, typographic_family_name, legacy_style_name, typographic_style_name, stat_policy) returns a TtfFont object representing a static instance of the variable font.
`SubsetCoverage`	Aggregate Unicode coverage diagnostics for a subsetting request.
`SubsetResult`	Subsetting output bundled with the coverage report used to produce it.
`TaskCompletionReceipt`	TaskCompletionReceipt.task_id identifies the task uniquely.
`TaskTokenEstimate`	TaskTokenEstimate.task_id is the unique identifier of the task.
`TextDeltaComparisonReport`	TextDeltaComparisonReport.to_dict() returns a dictionary containing all report fields.
`TextDeltaReport`	TextDeltaReport aggregates glyph‑level delta information, exposing glyph_count, active_glyph_count, and a collection of glyph_reports for QA inspection.
`TextLayout`	Result of a TextRenderer.layout() call.
`TextRenderer`	Lays out text using a font’s glyph metrics and optional kern pairs.
`TtfSerializer`	TtfSerializer.serialize serializes the given font object to a byte array, optionally using the provided sfnt version.
`TupleScalarDelta`	TupleScalarDelta.to_dict() returns a dict with tuple_index, before_scalar and after_scalar values.
`Type1Serializer`	Type1Serializer.serialize_pfb converts a font object to PFB binary data.
`UnsupportedFontFormatException`	Raised by FontLoader when the file magic bytes are not recognized.
`VariableAxis`	VariableAxis.normalize(value) returns the normalized (0‑1) position of a raw axis coordinate according to the axis’s defined range.
`VariableAxisPreset`	VariableAxisPreset.to_presentation(axis) returns a dictionary of presentation metadata for the preset, suitable for UI rendering of preset controls.
`VariableInstance`	VariableInstance.css_variation_settings(axes) produces a tuple of CSS `font-variation-settings` strings for the given collection of axes.
`WebFontAsset`	WebFontAsset.filename stores the original font file name as a string.
`WebFontBuilder`	WebFontBuilder can generate complete web‑font families with CSS, HTML preview pages and manifest files ready for deployment.
`WebFontBundle`	WebFontBundle.write_to writes the bundle to a directory and returns the list of written file paths.
`WebFontFamilyPackage`	WebFontFamilyPackage.write_to(directory) creates a complete family package containing CSS, HTML, a manifest, and all bundled font assets for multiple style variants.

Enumerations

Enumeration	Description
`FontType`	FontType.TTF represents the TrueType font format.

CFF Font Handling

Class	Description
`CffCharset`	CffCharset.standard(num_glyphs) creates a standard CFF charset for the given number of glyphs, and name_for(gid) returns the glyph name for a glyph ID.
`CffDict`	CffDict.from_bytes creates a CffDict instance from the given binary data.
`CffEncoding`	CffEncoding.unicode_to_gid(codepoint) returns the GlyphId for a Unicode codepoint according to the current CFF encoding.
`CffFont`	CffFont.get_kern_pairs() returns a list of KernPair objects representing the kerning adjustments defined in the font.
`CffIndex`	CffIndex.from_reader(r) creates a CffIndex instance by parsing data from a binary reader r.
`PrivateDict`	PrivateDict.from_dict(d) creates a PrivateDict instance from a dictionary containing private dict entries such as default_width_x and nominal_width_x.
`PrivateDictOp`	PrivateDictOp.BLUE_VALUES represents the BlueValues entry defining alignment zones for horizontal stems.
`TopDict`	TopDict.from_dict(d, string_index) creates a TopDict instance from a dictionary representation and a string‑index table, allowing programmatic reconstruction of font top‑level metadata.
`TopDictOp`	TopDictOp.VERSION represents the font’s version number.
`Type2Interpreter`	Interprets Type 2 charstrings into GlyphPath commands.

EOT Font Handling

Class	Description
`EotFont`	Embedded OpenType (EOT) wrapper over an inner TrueType/OpenType font.
`EotHeader`	EotHeader.eot_size is the total size of the EOT file in bytes.

TrueType Font Handling

Class	Description
`AvarAxisMap`	AvarAxisMap.mapping stores a list of (float, float) tuples that define input‑output value mappings for a variable font axis.
`AvarTable`	AvarTable.from_reader(r, length) constructs an AvarTable from a binary reader, and map_normalized(axis_index, value) returns the mapped float for a normalized axis coordinate.
`AxisRecord`	AxisRecord.tag stores the four‑character axis tag identifier (e.g., ‘wght’).
`CmapSubtable`	CmapSubtable.get_gid returns the glyph ID for a Unicode codepoint or None if unmapped.
`CmapTable`	CmapTable.from_reader(r, table_length) parses a cmap table from a font stream, and best_subtable() selects the most suitable CmapSubtable for Unicode lookups.
`DeltaSetIndex`	DeltaSetIndex.outer represents the outer index component of a delta set location.
`DeltaSetIndexMap`	DeltaSetIndexMap.from_reader(r) constructs a DeltaSetIndexMap from a binary reader, and get(gid) retrieves the corresponding DeltaSetIndex.
`FvarTable`	FvarTable.from_reader creates a new FvarTable by reading length bytes from a BinaryReader.
`GlyfTable`	GlyfTable.from_reader reads a GlyfTable from a BinaryReader using the specified length and returns a GlyfTable instance.
`GvarTable`	GvarTable.from_reader reads a GvarTable from a BinaryReader using the given length and axis tags.
`HMetric`	Class with 2 properties.
`HeadTable`	HeadTable.from_reader reads a BinaryReader and returns a populated HeadTable instance.
`HheaTable`	HheaTable.from_reader reads a BinaryReader and constructs a HheaTable object.
`HmtxTable`	HmtxTable.from_reader reads hmtx data from a BinaryReader and creates an HmtxTable instance.
`HvarTable`	HvarTable.advance_width_delta(gid, normalized_coordinates) returns the width adjustment for a glyph ID at the specified normalized axis coordinates.
`ItemVariationData`	ItemVariationData.from_reader creates an ItemVariationData instance by reading binary data from a BinaryReader.
`ItemVariationStore`	ItemVariationStore.evaluate(delta_set_index, coordinates) computes the delta adjustment for a variable‑font axis based on supplied normalized coordinates.
`KernTable`	KernTable.build_lookup() creates a dictionary mapping (left_gid, right_gid) tuples to kerning values for fast lookup.
`LocaTable`	LocaTable.glyph_offset(gid) returns the byte offset of the glyph data for the given glyph ID within the font’s glyf table.
`MaxpTable`	MaxpTable.to_bytes returns the binary encoding of the MaxpTable.
`NameRecord`	NameRecord.platform_id identifies the platform for which the name record applies.
`NameTable`	NameTable.language_key returns a language tag string for the given platform_id and language_id.
`NamedInstance`	NamedInstance.name_id is the integer identifier for the instance’s name record.
`NamingPolicyPreview`	Dry-run result for generated static-instance name records.
`Os2Table`	Os2Table.from_reader(r, table_length) parses an OS/2 table from a binary reader and returns an Os2Table instance.
`PlatformNamingDiagnostics`	PlatformNamingDiagnostics provides boolean flags and length checks (e.g., postscript_name_safe, postscript_name_length) to help ensure generated names meet platform constraints.
`PostTable`	PostTable.version holds the version number of the post table.
`StatNamingDiagnostics`	StatNamingDiagnostics reports whether the source font contains STAT tables and recommends appropriate stat_policy settings for export.
`TtcFaceRecord`	TtcFaceRecord.offset represents the byte offset of this face record within the TTC file.
`TtfFont`	TtfFont.save(path) writes the current font instance to the supplied filesystem path in its native format.
`TtfGlyphParser`	TtfGlyphParser.parse parses the glyph identified by the given GlyphId and returns a Glyph object.
`TtfInstancer`	TtfInstancer.preview_naming_policy returns a naming preview for a variable font instance based on given coordinates and naming options.
`TtfTableSet`	TtfTableSet.get_raw returns the raw bytes of the table identified by the given tag, or None if absent.
`TupleVariation`	TupleVariation.peak_coords holds the axis coordinate values that define the variation peak.
`VariationRegion`	VariationRegion.scalar returns a scalar value for the region based on given coordinate mapping and axis tag order.
`VariationRegionAxis`	VariationRegionAxis.scalar(coordinate) returns the scalar float value for a given coordinate along the axis, using the axis’s start, peak, and end properties.

Type1 Font Handling

Class	Description
`AfmData`	AfmData.font_name is the PostScript name of the font extracted from the AFM file.
`AfmGlyphMetric`	AfmGlyphMetric properties expose glyph name, code point, advance width, and bounding box for a glyph defined in an AFM file.
`PfbSegment`	PfbSegment.seg_type represents the integer identifier of the segment type in a PFB file.
`Type1Font`	Type1Font.load_afm loads an AFM file from the given path into the Type1Font instance.
`Type1FontData`	Type1FontData.full_name is the full human‑readable name of the font.
`Type1Interpreter`	Type1Interpreter.interpret interprets a Type 1 charstring and returns a GlyphPath with the bytes consumed.

WOFF / WOFF2 Handling

Class	Description
`Woff2Font`	Woff2Font.to_bytes(font_type) serializes the WOFF2 font into a bytes object for the specified font_type.
`WoffFont`	WoffFont.font_type returns the FontType enumeration value of this WOFF font.

Aspose.Font FOSS for Python

Core API

Enumerations

CFF Font Handling

EOT Font Handling

TrueType Font Handling

Type1 Font Handling

WOFF / WOFF2 Handling

See Also