python-fontbro 0.27.0__tar.gz → 0.28.1__tar.gz

{python_fontbro-0.27.0/python_fontbro.egg-info → python_fontbro-0.28.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-fontbro
-Version: 0.27.0
+Version: 0.28.1
 Summary: friendly font operations on top of fontTools.
 Author-email: Fabio Caccamo <fabio.caccamo@gmail.com>
 Maintainer-email: Fabio Caccamo <fabio.caccamo@gmail.com>
@@ -55,6 +55,7 @@ Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: fonttools[lxml,pathops,unicode,woff]<5.0,>=4.43.0
+Requires-Dist: gflanguages<1.0.0,>=0.7.11
 Requires-Dist: imagehash<5.0.0,>=4.2.1
 Requires-Dist: opentype-sanitizer<10.0.0,>=9.1.0
 Requires-Dist: pillow<13.0.0,>=12.2.0
@@ -73,6 +74,7 @@ Dynamic: license-file
 [![](https://img.shields.io/codacy/grade/dd3a046db4b14b988a2f1fcfbfaa51eb?logo=codacy)](https://www.codacy.com/app/fabiocaccamo/python-fontbro)
 [![](https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=black)](https://github.com/psf/black)
 [![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/fabiocaccamo/python-fontbro/badge)](https://securityscorecards.dev/viewer/?uri=github.com/fabiocaccamo/python-fontbro)
 
 # python-fontbro
 friendly font operations on top of `fontTools`. :billed_cap:
@@ -101,6 +103,7 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`from_collection`](#from_collection)
 -   [`get_characters`](#get_characters)
 -   [`get_characters_count`](#get_characters_count)
+-   [`get_embedding_permissions`](#get_embedding_permissions)
 -   [`get_family_classification`](#get_family_classification)
 -   [`get_family_name`](#get_family_name)
 -   [`get_features`](#get_features)
@@ -118,7 +121,11 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`get_style_flag`](#get_style_flag)
 -   [`get_style_flags`](#get_style_flags)
 -   [`get_style_name`](#get_style_name)
+-   [`get_supported_languages`](#get_supported_languages)
+-   [`get_supported_writing_systems`](#get_supported_writing_systems)
 -   [`get_svg`](#get_svg)
+-   [`get_tables`](#get_tables)
+-   [`get_tables_tags`](#get_tables_tags)
 -   [`get_ttfont`](#get_ttfont)
 -   [`get_unicode_block_by_name`](#get_unicode_block_by_name)
 -   [`get_unicode_blocks`](#get_unicode_blocks)
@@ -134,8 +141,10 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`get_vertical_metrics`](#get_vertical_metrics)
 -   [`get_weight`](#get_weight)
 -   [`get_width`](#get_width)
+-   [`is_bitmap`](#is_bitmap)
 -   [`is_color`](#is_color)
 -   [`is_monospace`](#is_monospace)
+-   [`is_pixel`](#is_pixel)
 -   [`is_static`](#is_static)
 -   [`is_variable`](#is_variable)
 -   [`rename`](#rename)
@@ -145,6 +154,7 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`save_as_woff2`](#save_as_woff2)
 -   [`save_to_file_object`](#save_to_file_object)
 -   [`save_variable_instances`](#save_variable_instances)
+-   [`set_embedding_permissions`](#set_embedding_permissions)
 -   [`set_family_classification`](#set_family_classification)
 -   [`set_family_name`](#set_family_name)
 -   [`set_name`](#set_name)
@@ -163,6 +173,7 @@ with open("fonts/MyFont.ttf") as fh:
 """
 Creates a new Font instance reading the same binary file.
 """
+
 font_clone = font.clone()
 ```
 
@@ -170,7 +181,10 @@ font_clone = font.clone()
 ```python
 """
 Close the wrapped TTFont instance.
+After closing, any operation on the font raises OperationError,
+closing an already closed font does nothing.
 """
+
 font.close()
 ```
 
@@ -185,6 +199,7 @@ Gets a list of Font objects from a font collection file (.ttc / .otc)
 :returns: A list of Font objects.
 :rtype: list
 """
+
 fonts = Font.from_collection(filepath="my-font-collection.ttc")
 ```
 
@@ -199,8 +214,9 @@ Gets the font characters.
 :returns: The characters.
 :rtype: generator of dicts
 
-:raises TypeError: If it's not possible to find the 'best' unicode cmap dict in the font.
+:raises DataError: If it's not possible to find the 'best' unicode cmap dict in the font.
 """
+
 chars = font.get_characters(ignore_blank=False)
 ```
 
@@ -215,9 +231,26 @@ Gets the font characters count.
 :returns: The characters count.
 :rtype: int
 """
+
 chars_count = font.get_characters_count(ignore_blank=False)
 ```
 
+#### `get_embedding_permissions`
+```python
+"""
+Gets the embedding permissions from the OS/2 fsType field.
+"installable" is True only when none of "restricted", "preview_and_print"
+and "editable" is set, since they are mutually exclusive usage permissions.
+
+:returns: A dictionary representing the embedding permission flags.
+:rtype: dict
+"""
+
+permissions = font.get_embedding_permissions()
+# {'installable': True, 'restricted': False, 'preview_and_print': False,
+#  'editable': False, 'no_subsetting': False, 'bitmap_embedding_only': False}
+```
+
 #### `get_family_classification`
 ```python
 """
@@ -235,6 +268,7 @@ If the OS/2 table is not available None is returned.
     }
 :rtype: dict
 """
+
 family_classification = font.get_family_classification()
 ```
 
@@ -246,6 +280,7 @@ Gets the family name reading the name records with priority order (16, 21, 1).
 :returns: The font family name.
 :rtype: str
 """
+
 family_name = font.get_family_name()
 ```
 
@@ -257,6 +292,7 @@ Gets the font opentype features.
 :returns: The features.
 :rtype: list of dict
 """
+
 features = font.get_features()
 ```
 
@@ -268,6 +304,7 @@ Gets the font opentype features tags.
 :returns: The features tags list.
 :rtype: list of str
 """
+
 features_tags = font.get_features_tags()
 ```
 
@@ -288,7 +325,10 @@ Gets the filename to use for saving the font to file-system.
 :returns: The filename.
 :rtype: str
 """
-filename = font.get_filename(variable_suffix="Variable", variable_axes_tags=True, variable_axes_values=False)
+
+filename = font.get_filename(
+    variable_suffix="Variable", variable_axes_tags=True, variable_axes_values=False
+)
 ```
 
 #### `get_fingerprint`
@@ -302,6 +342,7 @@ Changing the text option affects the returned fingerprint.
 :returns: The fingerprint hash.
 :rtype: imagehash.ImageHash
 """
+
 hash = font.get_fingerprint()
 ```
 
@@ -320,7 +361,10 @@ by checking if their fingerprints are equal (difference <= tolerance).
 :returns: A tuple containing the match info (match, diff, hash, other_hash).
 :rtype: tuple
 """
-match, diff, hash, other_hash = font.get_fingerprint_match(other="other_font.ttf", tolerance=10)
+
+match, diff, hash, other_hash = font.get_fingerprint_match(
+    other="other_font.ttf", tolerance=10
+)
 ```
 
 #### `get_format`
@@ -334,6 +378,7 @@ Gets the font format: otf, ttf, woff, woff2.
 :returns: The format.
 :rtype: str or None
 """
+
 format = font.get_format(ignore_flavor=False)
 ```
 
@@ -345,6 +390,7 @@ Gets the font glyphs and their own composition.
 :returns: The glyphs.
 :rtype: generator of dicts
 """
+
 glyphs = font.get_glyphs()
 ```
 
@@ -356,6 +402,7 @@ Gets the font glyphs count.
 :returns: The glyphs count.
 :rtype: int
 """
+
 glyphs_count = font.get_glyphs_count()
 ```
 
@@ -374,7 +421,10 @@ some text using the given options.
 :param background_color: The background color
 :type background_color: tuple
 """
-img = font.get_image(text="Hello!", size=48, color=(0, 0, 0, 255), background_color=(255, 255, 255, 255))
+
+img = font.get_image(
+    text="Hello!", size=48, color=(0, 0, 0, 255), background_color=(255, 255, 255, 255)
+)
 ```
 
 #### `get_italic_angle`
@@ -385,6 +435,7 @@ Gets the font italic angle.
 :returns: The angle value including backslant, italic and roman flags.
 :rtype: dict or None
 """
+
 italic_angle = font.get_italic_angle()
 ```
 
@@ -401,6 +452,7 @@ Gets the name by its identifier from the font name table.
 
 :raises KeyError: if the key is not a valid name key/id
 """
+
 family_name = font.get_name(key=Font.NAME_FAMILY_NAME)
 ```
 
@@ -412,6 +464,7 @@ Gets the names records mapped by their property name.
 :returns: The names.
 :rtype: dict
 """
+
 names = font.get_names()
 ```
 
@@ -426,6 +479,7 @@ Gets the style flag reading OS/2 and macStyle tables.
 :returns: The style flag.
 :rtype: bool
 """
+
 flag = font.get_style_flag(Font.STYLE_FLAG_BOLD)
 ```
 
@@ -437,6 +491,7 @@ Gets the style flags reading OS/2 and macStyle tables.
 :returns: The dict representing the style flags.
 :rtype: dict
 """
+
 flags = font.get_style_flags()
 ```
 
@@ -448,9 +503,60 @@ Gets the style name reading the name records with priority order (17, 22, 2).
 :returns: The font style name.
 :rtype: str
 """
+
 style_name = font.get_style_name()
 ```
 
+#### `get_supported_languages`
+```python
+"""
+Gets the languages supported by the font and their coverage.
+Only languages with coverage >= coverage_threshold (0.0 <= coverage_threshold <= 1.0) will be returned.
+The coverage is the ratio of the base characters of the language
+(as defined by the Google Fonts languages dataset) available in the font.
+
+:param coverage_threshold: The minumum required coverage for a language to be returned.
+:type coverage_threshold: float
+
+:returns: The list of supported languages.
+:rtype: list of dicts
+
+:raises DataError: If it's not possible to find the 'best' unicode cmap dict.
+"""
+
+languages = font.get_supported_languages(coverage_threshold=1.0)
+# [{'code': 'en_Latn', 'name': 'English', 'writing_system_code': 'Latn',
+#   'writing_system_name': 'Latin', 'coverage': 1.0, 'sample_texts': {...}}, ...]
+```
+
+#### `get_supported_writing_systems`
+```python
+"""
+Gets the writing systems supported by the font and their coverage.
+A writing system is supported if at least one of its languages is supported,
+the coverage is the ratio of the base characters of all its languages
+(as defined by the Google Fonts languages dataset) available in the font.
+
+:param coverage_threshold: The minumum required coverage for a language to be considered supported.
+:type coverage_threshold: float
+:param include_uncommon: If False, only the most common writing systems are returned.
+:type include_uncommon: bool
+:param prioritize_common: If True, the most common writing systems are returned first in a predefined order, otherwise all of them are sorted by name.
+:type prioritize_common: bool
+
+:returns: The list of supported writing systems.
+:rtype: list of dicts
+
+:raises DataError: If it's not possible to find the 'best' unicode cmap dict.
+"""
+
+writing_systems = font.get_supported_writing_systems(
+    coverage_threshold=1.0, include_uncommon=True, prioritize_common=True
+)
+# [{'code': 'Latn', 'name': 'Latin', 'coverage': 0.55, 'languages_count': 894,
+#   'languages_supported_count': 375, 'sample_texts': {...}}, ...]
+```
+
 #### `get_svg`
 ```python
 """
@@ -464,10 +570,56 @@ some text using the given options.
 
 :returns: An SVG string that represents the rendered text.
 :rtype: str
+
+:raises DataError: If it's not possible to find the 'best' unicode cmap dict.
 """
+
 svg_str = font.get_svg(text="Hello!", size=48)
 ```
 
+#### `get_tables`
+```python
+"""
+Gets the table metadata present in the font.
+Unknown tables are the ones not defined by the OpenType specification
+or by the Apple TrueType Reference Manual, their name is their tag.
+The length is the uncompressed table length (also for woff/woff2 fonts),
+the offset is the position of the table data in the loaded font file,
+it's None for woff2 fonts because tables are stored in a single
+compressed stream and have no individual offset in the file.
+Both length and offset are read from the originally loaded font file,
+so they will be None for tables added in-memory that haven't been saved.
+
+:param include_unknown: If False, unknown tables are excluded.
+:type include_unknown: bool
+
+:returns: The list of table metadata dictionaries.
+:rtype: list[dict]
+"""
+
+tables = font.get_tables(include_unknown=True)
+# [{'tag': 'head', 'name': 'Header', 'length': 54, 'offset': 192}, ...]
+```
+
+#### `get_tables_tags`
+```python
+"""
+Gets the tags of the tables present in the font.
+Unknown tables are the ones not defined by the OpenType specification
+or by the Apple TrueType Reference Manual, eg. custom tables or tables
+stored by font editors / tools (eg. VTT "TSI0"..."TSI5", FontForge "FFTM").
+
+:param include_unknown: If False, unknown tables are excluded.
+:type include_unknown: bool
+
+:returns: The list of table tags.
+:rtype: list[str]
+"""
+
+tables = font.get_tables_tags(include_unknown=True)
+# ['head', 'hhea', 'maxp', 'OS/2', ...]
+```
+
 #### `get_ttfont`
 ```python
 """
@@ -475,7 +627,10 @@ Gets the wrapped TTFont instance.
 
 :returns: The TTFont instance.
 :rtype: TTFont
+
+:raises OperationError: If the font has been closed.
 """
+
 ttfont = font.get_ttfont()
 ```
 
@@ -490,6 +645,7 @@ Gets the unicode block by name (name is case-insensitive and ignores "-").
 :returns: The unicode block dict if the name is valid, None otherwise.
 :rtype: dict or None
 """
+
 block = font.get_unicode_block_by_name(name="Basic Latin")
 ```
 
@@ -505,6 +661,7 @@ Only blocks with coverage >= coverage_threshold (0.0 <= coverage_threshold <= 1.
 :returns: The list of unicode blocks.
 :rtype: list of dicts
 """
+
 blocks = font.get_unicode_blocks(coverage_threshold=0.00001)
 ```
 
@@ -519,6 +676,7 @@ Gets the unicode script by name/tag (name/tag is case-insensitive and ignores "-
 :returns: The unicode script dict if the name/tag is valid, None otherwise.
 :rtype: dict or None
 """
+
 script = font.get_unicode_script_by_name(name="Latn")
 ```
 
@@ -534,6 +692,7 @@ Only scripts with coverage >= coverage_threshold (0.0 <= coverage_threshold <= 1
 :returns: The list of unicode scripts.
 :rtype: list of dicts
 """
+
 scripts = font.get_unicode_scripts(coverage_threshold=0.00001)
 ```
 
@@ -545,6 +704,7 @@ Gets the font variable axes.
 :returns: The list of axes if the font is a variable font otherwise None.
 :rtype: list of dict or None
 """
+
 axes = font.get_variable_axes()
 ```
 
@@ -556,6 +716,7 @@ Gets the variable axes tags.
 :returns: The variable axis tags.
 :rtype: list or None
 """
+
 axes_tags = font.get_variable_axes_tags()
 ```
 
@@ -570,6 +731,7 @@ Gets a variable axis by tag.
 :returns: The variable axis by tag.
 :rtype: dict or None
 """
+
 axis = font.get_variable_axis_by_tag(tag="wght")
 ```
 
@@ -581,6 +743,7 @@ Gets the variable instances.
 :returns: The list of instances if the font is a variable font otherwise None.
 :rtype: list of dict or None
 """
+
 instances = font.get_variable_instances()
 ```
 
@@ -595,6 +758,7 @@ Gets the variable instance by style name, eg. style_name = 'Bold'
 :returns: The variable instance matching the given style name.
 :rtype: dict or None
 """
+
 instance = font.get_variable_instance_by_style_name(style_name="Bold")
 ```
 
@@ -611,7 +775,10 @@ If coordinates do not specify some axes, axes default value is used for lookup.
 :returns: The variable instance closest to coordinates.
 :rtype: dict or None
 """
-instance = font.get_variable_instance_closest_to_coordinates(coordinates={"wght": 1000, "slnt": 815, "wdth": 775})
+
+instance = font.get_variable_instance_closest_to_coordinates(
+    coordinates={"wght": 1000, "slnt": 815, "wdth": 775}
+)
 ```
 
 #### `get_version`
@@ -622,6 +789,7 @@ Gets the font version.
 :returns: The font version value.
 :rtype: float
 """
+
 version = font.get_version()
 ```
 
@@ -636,6 +804,7 @@ Gets the font vertical metrics.
     "win_ascent", "win_descent"
 :rtype: dict
 """
+
 metrics = font.get_vertical_metrics()
 ```
 
@@ -647,6 +816,7 @@ Gets the font weight value and name.
 :returns: The weight name and value.
 :rtype: dict or None
 """
+
 weight = font.get_weight()
 ```
 
@@ -658,9 +828,25 @@ Gets the font width value and name.
 :returns: The width name and value.
 :rtype: dict or None
 """
+
 width = font.get_width()
 ```
 
+#### `is_bitmap`
+```python
+"""
+Determines if the font is a bitmap font: glyphs are stored only as
+monochrome bitmaps (EBDT/EBLC or Apple bdat/bloc tables), without outlines.
+Color bitmap fonts (eg. emoji fonts with CBDT/CBLC or sbix tables)
+are not considered bitmap fonts.
+
+:returns: True if bitmap font, False otherwise.
+:rtype: bool
+"""
+
+bitmap = font.is_bitmap()
+```
+
 #### `is_color`
 ```python
 """
@@ -669,21 +855,49 @@ Determines if the font is a color font.
 :returns: True if color font, False otherwise.
 :rtype: bool
 """
+
 color = font.is_color()
 ```
 
 #### `is_monospace`
 ```python
 """
-Determines if the font is a monospace font.
+Determines if the font is a monospace font (same criteria used by Fontbakery):
+if the font covers at least 80% of the printable ascii characters, at least
+threshold of their glyphs must have the same width, otherwise the glyphs of
+the characters (excluding marks) must have at most 2 different widths
+(eg. cjk monospace fonts with half-width and full-width characters).
+Zero-width glyphs are ignored.
 
-:param threshold: The threshold (0.0 <= n <= 1.0) of glyphs with the same width to consider the font as monospace.
+:param threshold: The threshold (0.0 <= n <= 1.0) of printable ascii characters glyphs with the same width to consider the font as monospace.
 :type threshold: float
 
 :returns: True if monospace font, False otherwise.
 :rtype: bool
 """
-mono = font.is_monospace(threshold=0.85)
+
+mono = font.is_monospace(threshold=0.8)
+```
+
+#### `is_pixel`
+```python
+"""
+Determines if the font is a pixel font: glyphs outlines are drawn
+with pixels (square or rectangular) aligned to a grid
+(horizontal / vertical segments only).
+The check is done on the A-Z, a-z and 0-9 glyphs, or if the font has none
+of them, on the first 50 glyphs (by codepoint) that are not punctuation,
+glyphs without outlines (eg. space) are ignored.
+Bitmap fonts (without outlines) are not considered pixel fonts.
+
+:param threshold: The threshold (0.0 <= n <= 1.0) of glyphs drawn with pixels to consider the font as pixel font.
+:type threshold: float
+
+:returns: True if pixel font, False otherwise.
+:rtype: bool
+"""
+
+pixel = font.is_pixel(threshold=0.9)
 ```
 
 #### `is_static`
@@ -694,6 +908,7 @@ Determines if the font is a static font.
 :returns: True if static font, False otherwise.
 :rtype: bool
 """
+
 static = font.is_static()
 ```
 
@@ -705,6 +920,7 @@ Determines if the font is a variable font.
 :returns: True if variable font, False otherwise.
 :rtype: bool
 """
+
 variable = font.is_variable()
 ```
 
@@ -726,7 +942,10 @@ If style_name is not defined it will be auto-detected.
 
 :raises ValueError: if the computed PostScript-name is longer than 63 characters.
 """
-font.rename(family_name="My Font New", style_name="Bold Italic", update_style_flags=True)
+
+font.rename(
+    family_name="My Font New", style_name="Bold Italic", update_style_flags=True
+)
 ```
 
 #### `sanitize`
@@ -747,6 +966,7 @@ https://github.com/googlefonts/ots-python
     If `strict` is True (default), treats sanitizer warnings as errors.
     If `strict` is False, only checks for sanitizer errors.
 """
+
 font.sanitize(strict=True)
 ```
 
@@ -765,6 +985,7 @@ Saves the font at filepath.
 
 :raises ValueError: If the filepath is the same of the source font and overwrite is not allowed.
 """
+
 saved_font_path = font.save(filepath=None, overwrite=False)
 ```
 
@@ -781,6 +1002,7 @@ Saves font as woff.
 :returns: The filepath where the font has been saved to.
 :rtype: str
 """
+
 saved_font_path = font.save_as_woff(filepath=None, overwrite=True)
 ```
 
@@ -797,6 +1019,7 @@ Saves font as woff2.
 :returns: The filepath where the font has been saved to.
 :rtype: str
 """
+
 saved_font_path = font.save_as_woff2(filepath=None, overwrite=True)
 ```
 
@@ -838,7 +1061,49 @@ Save all instances of a variable font to specified directory in one or more form
 :raises TypeError: If the font is not a variable font.
 """
 
-saved_fonts = font.save_variable_instances(dirpath, woff2=True, woff=True, overwrite=True, **options)
+saved_fonts = font.save_variable_instances(
+    dirpath, woff2=True, woff=True, overwrite=True, **options
+)
+```
+
+#### `set_embedding_permissions`
+```python
+"""
+Sets the embedding permissions in the OS/2 fsType field.
+Keys set to None will be ignored.
+"installable", "restricted", "preview_and_print" and "editable" are
+mutually exclusive usage permissions: exactly one of them is always
+in effect, so setting one of them to True replaces the current one,
+while setting the current one to False makes the font installable.
+The fsType field is left untouched if any argument is invalid.
+
+:param installable: The installable embedding permission flag,
+    it can be False only if another usage permission is in effect.
+:type installable: bool or None
+:param restricted: The restricted license embedding permission flag.
+:type restricted: bool or None
+:param preview_and_print: The preview and print embedding permission flag.
+:type preview_and_print: bool or None
+:param editable: The editable embedding permission flag.
+:type editable: bool or None
+:param no_subsetting: The no subsetting embedding permission flag.
+:type no_subsetting: bool or None
+:param bitmap_embedding_only: The bitmap-only embedding permission flag.
+:type bitmap_embedding_only: bool or None
+
+:raises ArgumentError: If a value is not a bool or None, if more than one
+    of the mutually exclusive usage permissions is set to True, or if
+    installable is set to False while no other usage permission is in effect.
+:raises OperationError: If the OS/2 table is not available in the font.
+"""
+
+font.set_embedding_permissions(
+    restricted=False,
+    preview_and_print=True,
+    editable=False,
+    no_subsetting=False,
+    bitmap_embedding_only=False,
+)
 ```
 
 #### `set_family_classification`
@@ -852,6 +1117,7 @@ based on provided class_id and subclass_id.
 :raises OperationError: If the OS/2 table is not available in the font.
 :raises ArgumentError: If class_id is invalid or subclass_id is specified but invalid.
 """
+
 font.set_family_classification(**font.FAMILY_CLASSIFICATION_SCRIPTS_CALLIGRAPHIC)
 # alternatively:
 font.set_family_classification(class_id=10, subclass_id=5)
@@ -865,6 +1131,7 @@ Sets the family name updating the related font names records.
 :param name: The name
 :type name: The new family name.
 """
+
 font.set_family_name(name="My Font New")
 ```
 
@@ -878,6 +1145,7 @@ Sets the name by its identifier in the font name table.
 :param value: The value
 :type value: str
 """
+
 font.set_name(Font.NAME_FAMILY_NAME, "Family Name Renamed")
 ```
 
@@ -889,10 +1157,13 @@ Sets the names by their identifier in the name table.
 :param names: The names
 :type names: dict
 """
-font.set_names(names={
-    Font.NAME_FAMILY_NAME: "Family Name Renamed",
-    Font.NAME_SUBFAMILY_NAME: "Regular Renamed",
-})
+
+font.set_names(
+    names={
+        Font.NAME_FAMILY_NAME: "Family Name Renamed",
+        Font.NAME_SUBFAMILY_NAME: "Regular Renamed",
+    }
+)
 ```
 
 #### `set_style_flag`
@@ -905,24 +1176,45 @@ Sets the style flag.
 :param value: The value
 :type value: bool
 """
+
 font.set_style_flag(Font.STYLE_FLAG_BOLD, True)
 ```
 
 #### `set_style_flags`
 ```python
 """
-Sets the style flags, flags set to None will be ignored.
+Sets the style flags, keys set to None will be ignored.
 
-:param bold: The bold flag value.
+:param regular: The regular style flag value
+:type regular: bool or None
+:param bold: The bold style flag value
 :type bold: bool or None
-:param italic: The italic flag value.
+:param italic: The italic style flag value
 :type italic: bool or None
-:param underline: The underline flag value.
+:param underline: The underline style flag value
 :type underline: bool or None
-:param outline: The outline flag value.
+:param outline: The outline style flag value
 :type outline: bool or None
+:param shadow: The shadow style flag value
+:type shadow: bool or None
+:param condensed: The condensed style flag value
+:type condensed: bool or None
+:param extended: The extended style flag value
+:type extended: bool or None
+
+:raises ArgumentError: If a value is not a bool or None.
 """
-font.set_style_flags(regular=None, bold=None, italic=None, outline=None, underline=None)
+
+font.set_style_flags(
+    regular=None,
+    bold=None,
+    italic=None,
+    underline=None,
+    outline=None,
+    shadow=None,
+    condensed=None,
+    extended=None,
+)
 ```
 
 #### `set_style_flags_by_subfamily_name`
@@ -932,6 +1224,7 @@ Sets the style flags by the subfamily name value.
 The subfamily values should be "regular", "italic", "bold" or "bold italic"
 to allow this method to work properly.
 """
+
 font.set_style_flags_by_subfamily_name()
 ```
 
@@ -943,6 +1236,7 @@ Sets the style name updating the related font names records.
 :param name: The name
 :type name: The new style name.
 """
+
 font.set_style_name(name="Bold Italic")
 ```
 
@@ -951,12 +1245,27 @@ font.set_style_name(name="Bold Italic")
 """
 Sets the vertical metrics.
 
-:param metrics: Keyword arguments representing the vertical metrics that can be set:
+:param vertical_metrics: Keyword arguments representing the vertical metrics that can be set:
     "units_per_em", "y_max", "y_min", "ascent", "descent", "line_gap",
     "typo_ascender", "typo_descender", "typo_line_gap", "cap_height", "x_height",
     "win_ascent", "win_descent"
 """
-font.set_vertical_metrics(units_per_em=2000, y_max=2102, y_min=-533, ascent=1800, descent=-400, line_gap=0, typo_ascender=1800, typo_descender=-400, typo_line_gap=0, cap_height=1400, x_height=1080, win_ascent=2160, win_descent=540)
+
+font.set_vertical_metrics(
+    units_per_em=2000,
+    y_max=2102,
+    y_min=-533,
+    ascent=1800,
+    descent=-400,
+    line_gap=0,
+    typo_ascender=1800,
+    typo_descender=-400,
+    typo_line_gap=0,
+    cap_height=1400,
+    x_height=1080,
+    win_ascent=2160,
+    win_descent=540,
+)
 ```
 
 #### `subset`
@@ -975,6 +1284,7 @@ https://github.com/fonttools/fonttools/blob/main/Lib/fontTools/subset/__init__.p
 :param options: The subsetter options
 :type options: dict
 """
+
 font.subset(unicodes="", glyphs=[], text="", **options)
 ```
 
@@ -998,6 +1308,7 @@ If an axis min and max values are equal, the axis will be pinned.
 :raises ValueError: If the coordinates are not defined (empty)
 :raises ValueError: If the coordinates axes are all pinned
 """
+
 font.to_sliced_variable(coordinates, **options)
 ```
 
@@ -1024,7 +1335,14 @@ If coordinates are not specified each axis will be pinned at its default value.
 :raises TypeError: If the font is not a variable font
 :raises ValueError: If the coordinates axes are not all pinned
 """
-font.to_static(coordinates=None, style_name=None, update_names=True, update_style_flags=True, **options)
+
+font.to_static(
+    coordinates=None,
+    style_name=None,
+    update_names=True,
+    update_style_flags=True,
+    **options,
+)
 ```
 
 ## Testing