idx
int64
0
63k
question
stringlengths
61
4.03k
target
stringlengths
6
1.23k
53,700
def add_log_file ( logger , log_file , global_log_file = False ) : if global_log_file : add_root_log_file ( log_file ) else : hdlr = logging . FileHandler ( log_file ) formatter = logging . Formatter ( '%(asctime)s %(name)-10s %(levelname)-8s %(message)s' , datefmt = '%m-%d %H:%M:%S' ) hdlr . setFormatter ( formatter )...
Add a log file to this logger . If global_log_file is true log_file will be handed the root logger otherwise it will only be used by this particular logger .
53,701
def get_module_profile ( module , name = None ) : try : return module . profile except AttributeError : if 'profile_factory' not in module . __dict__ : return None default_section = Section ( name or module . __name__ ) profile = module . profile_factory ( default_section = default_section ) profile . auto_register ( m...
Get or create a profile from a module and return it .
53,702
def iterargs ( self ) : iterargs = OrderedDict ( ) for name in self . _iterargs : plural = self . _profile . iterargs [ name ] iterargs [ name ] = tuple ( self . _values [ plural ] ) return iterargs
uses the singular name as key
53,703
def _exec_check ( self , check : FontbakeryCallable , args : Dict [ str , Any ] ) : try : result = check ( ** args ) if isinstance ( result , types . GeneratorType ) : for sub_result in result : yield self . _check_result ( sub_result ) return except Exception as e : error = FailedCheckError ( e ) result = ( ERROR , er...
Yields check sub results .
53,704
def check_order ( self , order ) : own_order = self . order for item in order : if item not in own_order : raise ValueError ( f'Order item {item} not found.' ) return order
order must be a subset of self . order
53,705
def add_check ( self , check ) : if self . _add_check_callback is not None : if not self . _add_check_callback ( self , check ) : return False self . _checkid2index [ check . id ] = len ( self . _checks ) self . _checks . append ( check ) return True
Please use rather register_check as a decorator .
53,706
def merge_section ( self , section , filter_func = None ) : for check in section . checks : if filter_func and not filter_func ( check ) : continue self . add_check ( check )
Add section . checks to self if not skipped by self . _add_check_callback . order description etc . are not updated .
53,707
def validate_values ( self , values ) : format_message = '{}: {} (value: {})' . format messages = [ ] for name , value in values . items ( ) : if name not in self . expected_values : continue valid , message = self . expected_values [ name ] . validate ( value ) if valid : continue messages . append ( format_message ( ...
Validate values if they are registered as expected_values and present .
53,708
def _get_aggregate_args ( self , item , key ) : if not key in ( 'args' , 'mandatoryArgs' ) : raise TypeError ( 'key must be "args" or "mandatoryArgs", got {}' ) . format ( key ) dependencies = list ( getattr ( item , key ) ) if hasattr ( item , 'conditions' ) : dependencies += [ name for negated , name in map ( is_nega...
Get all arguments or mandatory arguments of the item .
53,709
def get_iterargs ( self , item ) : args = self . _get_aggregate_args ( item , 'mandatoryArgs' ) return tuple ( sorted ( [ arg for arg in args if arg in self . iterargs ] ) )
Returns a tuple of all iterags for item sorted by name .
53,710
def auto_register ( self , symbol_table , filter_func = None , profile_imports = None ) : if profile_imports : symbol_table = symbol_table . copy ( ) symbol_table [ 'profile_imports' ] = profile_imports all_items = list ( symbol_table . values ( ) ) + self . _load_profile_imports ( symbol_table ) namespace_types = ( Fo...
Register items from symbol_table in the profile .
53,711
def merge_profile ( self , profile , filter_func = None ) : for ns_type in self . _valid_namespace_types : ns_dict = getattr ( profile , ns_type ) if filter_func : ns_type_singular = self . _valid_namespace_types [ ns_type ] ns_dict = { name : item for name , item in ns_dict . items ( ) if filter_func ( ns_type_singula...
Copy all namespace items from profile to self .
53,712
def serialize_identity ( self , identity ) : section , check , iterargs = identity values = map ( partial ( json . dumps , separators = ( ',' , ':' ) ) , [ str ( section ) , check . id , sorted ( iterargs ) ] ) return '{{"section":{},"check":{},"iterargs":{}}}' . format ( * values )
Return a json string that can also be used as a key .
53,713
def get_profile ( ) : argument_parser = ThrowingArgumentParser ( add_help = False ) argument_parser . add_argument ( 'profile' ) try : args , _ = argument_parser . parse_known_args ( ) except ArgumentParserError : return Profile ( ) imported = get_module ( args . profile ) profile = get_module_profile ( imported ) if n...
Prefetch the profile module to fill some holes in the help text .
53,714
def collate_fonts_data ( fonts_data ) : glyphs = { } for family in fonts_data : for glyph in family : if glyph [ 'unicode' ] not in glyphs : glyphs [ glyph [ 'unicode' ] ] = glyph else : c = glyphs [ glyph [ 'unicode' ] ] [ 'contours' ] glyphs [ glyph [ 'unicode' ] ] [ 'contours' ] = c | glyph [ 'contours' ] return gly...
Collate individual fonts data into a single glyph data list .
53,715
def com_adobe_fonts_check_family_consistent_upm ( ttFonts ) : upm_set = set ( ) for ttFont in ttFonts : upm_set . add ( ttFont [ 'head' ] . unitsPerEm ) if len ( upm_set ) > 1 : yield FAIL , ( "Fonts have different units per em: {}." ) . format ( sorted ( upm_set ) ) else : yield PASS , "Fonts have consistent units per...
Fonts have consistent Units Per Em?
53,716
def com_adobe_fonts_check_find_empty_letters ( ttFont ) : cmap = ttFont . getBestCmap ( ) passed = True letter_categories = { 'Ll' , 'Lm' , 'Lo' , 'Lt' , 'Lu' , } invisible_letters = { 0x115F , 0x1160 , 0x3164 , 0xFFA0 , } for unicode_val , glyph_name in cmap . items ( ) : category = unicodedata . category ( chr ( unic...
Letters in font have glyphs that are not empty?
53,717
def com_adobe_fonts_check_name_empty_records ( ttFont ) : failed = False for name_record in ttFont [ 'name' ] . names : name_string = name_record . toUnicode ( ) . strip ( ) if len ( name_string ) == 0 : failed = True name_key = tuple ( [ name_record . platformID , name_record . platEncID , name_record . langID , name_...
Check name table for empty records .
53,718
def com_google_fonts_check_name_no_copyright_on_description ( ttFont ) : failed = False for name in ttFont [ 'name' ] . names : if 'opyright' in name . string . decode ( name . getEncoding ( ) ) and name . nameID == NameID . DESCRIPTION : failed = True if failed : yield FAIL , ( "Namerecords with ID={} (NameID.DESCRIPT...
Description strings in the name table must not contain copyright info .
53,719
def com_google_fonts_check_monospace ( ttFont , glyph_metrics_stats ) : from fontbakery . constants import ( IsFixedWidth , PANOSE_Proportion ) failed = False seems_monospaced = glyph_metrics_stats [ "seems_monospaced" ] most_common_width = glyph_metrics_stats [ "most_common_width" ] width_max = glyph_metrics_stats [ '...
Checking correctness of monospaced metadata .
53,720
def com_google_fonts_check_name_line_breaks ( ttFont ) : failed = False for name in ttFont [ "name" ] . names : string = name . string . decode ( name . getEncoding ( ) ) if "\n" in string : failed = True yield FAIL , ( "Name entry {} on platform {} contains" " a line-break." ) . format ( NameID ( name . nameID ) . nam...
Name table entries should not contain line - breaks .
53,721
def com_google_fonts_check_name_match_familyname_fullfont ( ttFont ) : from fontbakery . utils import get_name_entry_strings familyname = get_name_entry_strings ( ttFont , NameID . FONT_FAMILY_NAME ) fullfontname = get_name_entry_strings ( ttFont , NameID . FULL_FONT_NAME ) if len ( familyname ) == 0 : yield FAIL , Mes...
Does full font name begin with the font family name?
53,722
def com_google_fonts_check_family_naming_recommendations ( ttFont ) : import re from fontbakery . utils import get_name_entry_strings bad_entries = [ ] bad_psname = re . compile ( "[^A-Za-z0-9-]" ) for string in get_name_entry_strings ( ttFont , NameID . POSTSCRIPT_NAME ) : if bad_psname . search ( string ) : bad_entri...
Font follows the family naming recommendations?
53,723
def com_google_fonts_check_name_rfn ( ttFont ) : failed = False for entry in ttFont [ "name" ] . names : string = entry . toUnicode ( ) if "reserved font name" in string . lower ( ) : yield WARN , ( "Name table entry (\"{}\")" " contains \"Reserved Font Name\"." " This is an error except in a few specific" " rare cases...
Name table strings must not contain the string Reserved Font Name .
53,724
def com_adobe_fonts_check_family_max_4_fonts_per_family_name ( ttFonts ) : from collections import Counter from fontbakery . utils import get_name_entry_strings failed = False family_names = list ( ) for ttFont in ttFonts : names_list = get_name_entry_strings ( ttFont , NameID . FONT_FAMILY_NAME ) names_set = set ( nam...
Verify that each group of fonts with the same nameID 1 has maximum of 4 fonts
53,725
def com_google_fonts_check_family_equal_unicode_encodings ( ttFonts ) : encoding = None failed = False for ttFont in ttFonts : cmap = None for table in ttFont [ 'cmap' ] . tables : if table . format == 4 : cmap = table break if not encoding : encoding = cmap . platEncID if encoding != cmap . platEncID : failed = True i...
Fonts have equal unicode encodings?
53,726
def com_google_fonts_check_all_glyphs_have_codepoints ( ttFont ) : failed = False for subtable in ttFont [ 'cmap' ] . tables : if subtable . isUnicode ( ) : for item in subtable . cmap . items ( ) : codepoint = item [ 0 ] if codepoint is None : failed = True yield FAIL , ( "Glyph {} lacks a unicode" " codepoint assignm...
Check all glyphs have codepoints assigned .
53,727
def run ( self , order = None ) : for event in self . runner . run ( order = order ) : self . receive ( event )
self . runner must be present
53,728
def com_google_fonts_check_name_trailing_spaces ( ttFont ) : failed = False for name_record in ttFont [ 'name' ] . names : name_string = name_record . toUnicode ( ) if name_string != name_string . strip ( ) : failed = True name_key = tuple ( [ name_record . platformID , name_record . platEncID , name_record . langID , ...
Name table records must not have trailing spaces .
53,729
def com_google_fonts_check_family_single_directory ( fonts ) : directories = [ ] for target_file in fonts : directory = os . path . dirname ( target_file ) if directory not in directories : directories . append ( directory ) if len ( directories ) == 1 : yield PASS , "All files are in the same directory." else : yield ...
Checking all files are in the same directory .
53,730
def com_google_fonts_check_ftxvalidator ( font ) : import plistlib try : import subprocess ftx_cmd = [ "ftxvalidator" , "-t" , "all" , font ] ftx_output = subprocess . check_output ( ftx_cmd , stderr = subprocess . STDOUT ) ftx_data = plistlib . loads ( ftx_output ) if 'kATSFontTestSeverityFatalError' not in ftx_data [...
Checking with ftxvalidator .
53,731
def com_google_fonts_check_ots ( font ) : import ots try : process = ots . sanitize ( font , check = True , capture_output = True ) except ots . CalledProcessError as e : yield FAIL , ( "ots-sanitize returned an error code ({}). Output follows:\n\n{}{}" ) . format ( e . returncode , e . stderr . decode ( ) , e . stdout...
Checking with ots - sanitize .
53,732
def com_google_fonts_check_fontbakery_version ( ) : try : import subprocess installed_str = None latest_str = None is_latest = False failed = False pip_cmd = [ "pip" , "search" , "fontbakery" ] pip_output = subprocess . check_output ( pip_cmd , stderr = subprocess . STDOUT ) for line in pip_output . decode ( ) . split ...
Do we have the latest version of FontBakery installed?
53,733
def com_google_fonts_check_fontforge_stderr ( font , fontforge_check_results ) : if "skip" in fontforge_check_results : yield SKIP , fontforge_check_results [ "skip" ] return filtered_err_msgs = "" for line in fontforge_check_results [ "ff_err_messages" ] . split ( '\n' ) : if ( 'The following table(s) in the font' ' h...
FontForge validation outputs error messages?
53,734
def com_google_fonts_check_mandatory_glyphs ( ttFont ) : from fontbakery . utils import glyph_has_ink if ( ttFont . getGlyphOrder ( ) [ 0 ] == ".notdef" and ".notdef" not in ttFont . getBestCmap ( ) . values ( ) and glyph_has_ink ( ttFont , ".notdef" ) ) : yield PASS , ( "Font contains the .notdef glyph as the first gl...
Font contains . notdef as first glyph?
53,735
def com_google_fonts_check_whitespace_ink ( ttFont ) : from fontbakery . utils import get_glyph_name , glyph_has_ink WHITESPACE_CHARACTERS = [ 0x0009 , 0x000A , 0x000B , 0x000C , 0x000D , 0x0020 , 0x0085 , 0x00A0 , 0x1680 , 0x2000 , 0x2001 , 0x2002 , 0x2003 , 0x2004 , 0x2005 , 0x2006 , 0x2007 , 0x2008 , 0x2009 , 0x200A...
Whitespace glyphs have ink?
53,736
def com_google_fonts_check_required_tables ( ttFont ) : from . shared_conditions import is_variable_font REQUIRED_TABLES = { "cmap" , "head" , "hhea" , "hmtx" , "maxp" , "name" , "OS/2" , "post" } OPTIONAL_TABLES = { "cvt " , "fpgm" , "loca" , "prep" , "VORG" , "EBDT" , "EBLC" , "EBSC" , "BASE" , "GPOS" , "GSUB" , "JST...
Font contains all required tables?
53,737
def com_google_fonts_check_unwanted_tables ( ttFont ) : UNWANTED_TABLES = { 'FFTM' : '(from FontForge)' , 'TTFA' : '(from TTFAutohint)' , 'TSI0' : '(from VTT)' , 'TSI1' : '(from VTT)' , 'TSI2' : '(from VTT)' , 'TSI3' : '(from VTT)' , 'TSI5' : '(from VTT)' , 'prop' : '' } unwanted_tables_found = [ ] for table in ttFont ...
Are there unwanted tables?
53,738
def com_google_fonts_check_valid_glyphnames ( ttFont ) : if ttFont . sfntVersion == b'\x00\x01\x00\x00' and ttFont . get ( "post" ) and ttFont [ "post" ] . formatType == 3.0 : yield SKIP , ( "TrueType fonts with a format 3.0 post table contain no" " glyph names." ) else : import re bad_names = [ ] for _ , glyphName in ...
Glyph names are all valid?
53,739
def com_google_fonts_check_unique_glyphnames ( ttFont ) : if ttFont . sfntVersion == b'\x00\x01\x00\x00' and ttFont . get ( "post" ) and ttFont [ "post" ] . formatType == 3.0 : yield SKIP , ( "TrueType fonts with a format 3.0 post table contain no" " glyph names." ) else : import re glyphs = [ ] duplicated_glyphIDs = [...
Font contains unique glyph names?
53,740
def com_google_fonts_check_glyphnames_max_length ( ttFont ) : if ttFont . sfntVersion == b'\x00\x01\x00\x00' and ttFont . get ( "post" ) and ttFont [ "post" ] . formatType == 3.0 : yield PASS , ( "TrueType fonts with a format 3.0 post table contain no " "glyph names." ) else : failed = False for name in ttFont . getGly...
Check that glyph names do not exceed max length .
53,741
def com_google_fonts_check_ttx_roundtrip ( font ) : from fontTools import ttx import sys ttFont = ttx . TTFont ( font ) failed = False class TTXLogger : msgs = [ ] def __init__ ( self ) : self . original_stderr = sys . stderr self . original_stdout = sys . stdout sys . stderr = self sys . stdout = self def write ( self...
Checking with fontTools . ttx
53,742
def com_google_fonts_check_family_vertical_metrics ( ttFonts ) : failed = [ ] vmetrics = { "sTypoAscender" : { } , "sTypoDescender" : { } , "sTypoLineGap" : { } , "usWinAscent" : { } , "usWinDescent" : { } , "ascent" : { } , "descent" : { } } for ttfont in ttFonts : full_font_name = ttfont [ 'name' ] . getName ( 4 , 3 ...
Each font in a family must have the same vertical metrics values .
53,743
def com_google_fonts_check_linegaps ( ttFont ) : if ttFont [ "hhea" ] . lineGap != 0 : yield WARN , Message ( "hhea" , "hhea lineGap is not equal to 0." ) elif ttFont [ "OS/2" ] . sTypoLineGap != 0 : yield WARN , Message ( "OS/2" , "OS/2 sTypoLineGap is not equal to 0." ) else : yield PASS , "OS/2 sTypoLineGap and hhea...
Checking Vertical Metric Linegaps .
53,744
def com_google_fonts_check_maxadvancewidth ( ttFont ) : hhea_advance_width_max = ttFont [ 'hhea' ] . advanceWidthMax hmtx_advance_width_max = None for g in ttFont [ 'hmtx' ] . metrics . values ( ) : if hmtx_advance_width_max is None : hmtx_advance_width_max = max ( 0 , g [ 0 ] ) else : hmtx_advance_width_max = max ( g ...
MaxAdvanceWidth is consistent with values in the Hmtx and Hhea tables?
53,745
def com_google_fonts_check_monospace_max_advancewidth ( ttFont , glyph_metrics_stats ) : from fontbakery . utils import pretty_print_list seems_monospaced = glyph_metrics_stats [ "seems_monospaced" ] if not seems_monospaced : yield SKIP , ( "Font is not monospaced." ) return max_advw = ttFont [ 'hhea' ] . advanceWidthM...
Monospace font has hhea . advanceWidthMax equal to each glyph s advanceWidth?
53,746
def glyph_metrics_stats ( ttFont ) : glyph_metrics = ttFont [ 'hmtx' ] . metrics ascii_glyph_names = [ ttFont . getBestCmap ( ) [ c ] for c in range ( 32 , 128 ) if c in ttFont . getBestCmap ( ) ] ascii_widths = [ adv for name , ( adv , lsb ) in glyph_metrics . items ( ) if name in ascii_glyph_names ] ascii_width_count...
Returns a dict containing whether the font seems_monospaced what s the maximum glyph width and what s the most common width .
53,747
def vtt_talk_sources ( ttFont ) -> List [ str ] : VTT_SOURCE_TABLES = { 'TSI0' , 'TSI1' , 'TSI2' , 'TSI3' , 'TSI5' } tables_found = [ tag for tag in ttFont . keys ( ) if tag in VTT_SOURCE_TABLES ] return tables_found
Return the tags of VTT source tables found in a font .
53,748
def write ( self , data ) : self . _buffer . append ( data ) self . _current_ticks += 1 flush = False if self . _last_flush_time is None or ( self . _holdback_time is None and self . _max_ticks == 0 ) : flush = True elif self . _max_ticks and self . _current_ticks >= self . _max_ticks or self . _holdback_time and time ...
only put to stdout every now and then
53,749
def flush ( self , draw_progress = True ) : reset_progressbar = None if self . _draw_progressbar and draw_progress : progressbar , reset_progressbar = self . _draw_progressbar ( ) self . _buffer . append ( progressbar ) for line in self . _buffer : self . _outFile . write ( line ) self . _buffer = [ ] if reset_progress...
call this at the very end so that we can output the rest
53,750
def _draw_progressbar ( self , columns = None , len_prefix = 0 , right_margin = 0 ) : if self . _order == None : total = len ( self . _results ) else : total = max ( len ( self . _order ) , len ( self . _results ) ) percent = int ( round ( len ( self . _results ) / total * 100 ) ) if total else 0 needs_break = lambda c...
if columns is None don t insert any extra line breaks
53,751
def download_file ( url , dst_path ) : request = requests . get ( url , stream = True ) with open ( dst_path , 'wb' ) as downloaded_file : request . raw . decode_content = True shutil . copyfileobj ( request . raw , downloaded_file )
Download a file from a url
53,752
def download_fonts ( gh_url , dst ) : font_paths = [ ] r = requests . get ( gh_url ) for item in r . json ( ) : if item [ 'name' ] . endswith ( ".ttf" ) : f = item [ 'download_url' ] dl_path = os . path . join ( dst , os . path . basename ( f ) ) download_file ( f , dl_path ) font_paths . append ( dl_path ) return font...
Download fonts from a github dir
53,753
def com_google_fonts_check_family_equal_font_versions ( ttFonts ) : all_detected_versions = [ ] fontfile_versions = { } for ttFont in ttFonts : v = ttFont [ 'head' ] . fontRevision fontfile_versions [ ttFont ] = v if v not in all_detected_versions : all_detected_versions . append ( v ) if len ( all_detected_versions ) ...
Make sure all font files have the same version value .
53,754
def com_google_fonts_check_unitsperem ( ttFont ) : upem = ttFont [ 'head' ] . unitsPerEm target_upem = [ 2 ** i for i in range ( 4 , 15 ) ] target_upem . append ( 1000 ) target_upem . append ( 2000 ) if upem < 16 or upem > 16384 : yield FAIL , ( "The value of unitsPerEm at the head table" " must be a value between 16 a...
Checking unitsPerEm value is reasonable .
53,755
def cached_getter ( func ) : @ wraps ( func ) def wrapper ( self ) : attribute = f'_{func.__name__}' value = getattr ( self , attribute , None ) if value is None : value = func ( self ) setattr ( self , attribute , value ) return value return wrapper
Decorate a property by executing it at instatiation time and cache the result on the instance object .
53,756
def condition ( * args , ** kwds ) : if len ( args ) == 1 and len ( kwds ) == 0 and callable ( args [ 0 ] ) : func = args [ 0 ] return wraps ( func ) ( FontBakeryCondition ( func ) ) else : def wrapper ( func ) : return wraps ( func ) ( FontBakeryCondition ( func , * args , ** kwds ) ) return wrapper
Check wrapper a factory for FontBakeryCondition
53,757
def check ( * args , ** kwds ) : def wrapper ( checkfunc ) : return wraps ( checkfunc ) ( FontBakeryCheck ( checkfunc , * args , ** kwds ) ) return wrapper
Check wrapper a factory for FontBakeryCheck
53,758
def get_bounding_box ( font ) : ymin = 0 ymax = 0 if font . sfntVersion == 'OTTO' : ymin = font [ 'head' ] . yMin ymax = font [ 'head' ] . yMax else : for g in font [ 'glyf' ] . glyphs : char = font [ 'glyf' ] [ g ] if hasattr ( char , 'yMin' ) and ymin > char . yMin : ymin = char . yMin if hasattr ( char , 'yMax' ) an...
Returns max and min bbox of given truetype font
53,759
def glyph_contour_count ( font , name ) : contour_count = 0 items = [ font [ 'glyf' ] [ name ] ] while items : g = items . pop ( 0 ) if g . isComposite ( ) : for comp in g . components : if comp . glyphName != ".ttfautohint" : items . append ( font [ 'glyf' ] [ comp . glyphName ] ) if g . numberOfContours != - 1 : cont...
Contour count for specified glyph . This implementation will also return contour count for composite glyphs .
53,760
def get_font_glyph_data ( font ) : from fontbakery . constants import ( PlatformID , WindowsEncodingID ) font_data = [ ] try : subtable = font [ 'cmap' ] . getcmap ( PlatformID . WINDOWS , WindowsEncodingID . UNICODE_BMP ) if not subtable : subtable = font [ 'cmap' ] . tables [ 0 ] cmap = subtable . cmap except : retur...
Return information for each glyph in a font
53,761
def glyph_has_ink ( font : TTFont , name : Text ) -> bool : if 'glyf' in font : return ttf_glyph_has_ink ( font , name ) elif ( 'CFF ' in font ) or ( 'CFF2' in font ) : return cff_glyph_has_ink ( font , name ) else : raise Exception ( "Could not find 'glyf', 'CFF ', or 'CFF2' table." )
Checks if specified glyph has any ink .
53,762
def assert_results_contain ( check_results , expected_status , expected_msgcode = None ) : found = False for status , message in check_results : if status == expected_status and message . code == expected_msgcode : found = True break assert ( found )
This helper function is useful when we want to make sure that a certain log message is emited by a check but it can be in any order among other log messages .
53,763
def com_google_fonts_check_family_underline_thickness ( ttFonts ) : underTs = { } underlineThickness = None failed = False for ttfont in ttFonts : fontname = ttfont . reader . file . name ut = ttfont [ 'post' ] . underlineThickness underTs [ fontname ] = ut if underlineThickness is None : underlineThickness = ut if ut ...
Fonts have consistent underline thickness?
53,764
def summary_table ( errors : int , fails : int , warns : int , skips : int , infos : int , passes : int , total : int ) -> str : return f
Return summary table with statistics .
53,765
def get_html ( self ) -> str : data = self . getdoc ( ) num_checks = 0 body_elements = [ ] for section in data [ "sections" ] : section_name = html . escape ( section [ "key" ] [ 0 ] ) section_stati_of_note = ( e for e in section [ "result" ] . elements ( ) if e != "PASS" ) section_stati = "" . join ( EMOTICON [ s ] fo...
Return complete report as a HTML string .
53,766
def omit_loglevel ( self , msg ) -> bool : return self . loglevels and ( self . loglevels [ 0 ] > fontbakery . checkrunner . Status ( msg ) )
Determine if message is below log level .
53,767
def html_for_check ( self , check ) -> str : check [ "logs" ] . sort ( key = lambda c : LOGLEVELS . index ( c [ "status" ] ) ) logs = "<ul>" + "" . join ( [ self . log_html ( log ) for log in check [ "logs" ] ] ) + "</ul>" return logs
Return HTML string for complete single check .
53,768
def log_html ( self , log ) -> str : if not self . omit_loglevel ( log [ "status" ] ) : emoticon = EMOTICON [ log [ "status" ] ] status = log [ "status" ] message = html . escape ( log [ "message" ] ) . replace ( "\n" , "<br/>" ) return ( "<li class='details_item'>" f"<span class='details_indicator'>{emoticon} {status}...
Return single check sub - result string as HTML or not if below log level .
53,769
def style ( font ) : from fontbakery . constants import STATIC_STYLE_NAMES filename = os . path . basename ( font ) if '-' in filename : stylename = os . path . splitext ( filename ) [ 0 ] . split ( '-' ) [ 1 ] if stylename in [ name . replace ( ' ' , '' ) for name in STATIC_STYLE_NAMES ] : return stylename return None
Determine font style from canonical filename .
53,770
def canonical_stylename ( font ) : from fontbakery . constants import ( STATIC_STYLE_NAMES , VARFONT_SUFFIXES ) from fontbakery . profiles . shared_conditions import is_variable_font from fontTools . ttLib import TTFont valid_style_suffixes = [ name . replace ( ' ' , '' ) for name in STATIC_STYLE_NAMES ] filename = os ...
Returns the canonical stylename of a given font .
53,771
def com_google_fonts_check_canonical_filename ( font ) : from fontTools . ttLib import TTFont from fontbakery . profiles . shared_conditions import is_variable_font from fontbakery . constants import ( STATIC_STYLE_NAMES , VARFONT_SUFFIXES ) if canonical_stylename ( font ) : yield PASS , f"{font} is named canonically."...
Checking file is named canonically .
53,772
def family_directory ( fonts ) : if fonts : dirname = os . path . dirname ( fonts [ 0 ] ) if dirname == '' : dirname = '.' return dirname
Get the path of font project directory .
53,773
def descfile ( family_directory ) : if family_directory : descfilepath = os . path . join ( family_directory , "DESCRIPTION.en_us.html" ) if os . path . exists ( descfilepath ) : return descfilepath
Get the path of the DESCRIPTION file of a given font project .
53,774
def com_google_fonts_check_description_broken_links ( description ) : from lxml . html import HTMLParser import defusedxml . lxml import requests doc = defusedxml . lxml . fromstring ( description , parser = HTMLParser ( ) ) broken_links = [ ] for link in doc . xpath ( '//a/@href' ) : if link . startswith ( "mailto:" )...
Does DESCRIPTION file contain broken links?
53,775
def com_google_fonts_check_metadata_parses ( family_directory ) : from google . protobuf import text_format from fontbakery . utils import get_FamilyProto_Message try : pb_file = os . path . join ( family_directory , "METADATA.pb" ) get_FamilyProto_Message ( pb_file ) yield PASS , "METADATA.pb parsed successfuly." exce...
Check METADATA . pb parse correctly .
53,776
def com_google_fonts_check_family_equal_numbers_of_glyphs ( ttFonts ) : the_ttFonts = list ( ttFonts ) failed = False max_stylename = None max_count = 0 max_glyphs = None for ttFont in the_ttFonts : fontname = ttFont . reader . file . name stylename = canonical_stylename ( fontname ) this_count = len ( ttFont [ 'glyf' ...
Fonts have equal numbers of glyphs?
53,777
def com_google_fonts_check_family_equal_glyph_names ( ttFonts ) : fonts = list ( ttFonts ) all_glyphnames = set ( ) for ttFont in fonts : all_glyphnames |= set ( ttFont [ "glyf" ] . glyphs . keys ( ) ) missing = { } available = { } for glyphname in all_glyphnames : missing [ glyphname ] = [ ] available [ glyphname ] = ...
Fonts have equal glyph names?
53,778
def registered_vendor_ids ( ) : from bs4 import BeautifulSoup from pkg_resources import resource_filename registered_vendor_ids = { } CACHED = resource_filename ( 'fontbakery' , 'data/fontbakery-microsoft-vendorlist.cache' ) content = open ( CACHED , encoding = 'utf-8' ) . read ( ) soup = BeautifulSoup ( content , 'htm...
Get a list of vendor IDs from Microsoft s website .
53,779
def com_google_fonts_check_name_unwanted_chars ( ttFont ) : failed = False replacement_map = [ ( "\u00a9" , '(c)' ) , ( "\u00ae" , '(r)' ) , ( "\u2122" , '(tm)' ) ] for name in ttFont [ 'name' ] . names : string = str ( name . string , encoding = name . getEncoding ( ) ) for mark , ascii_repl in replacement_map : new_s...
Substitute copyright registered and trademark symbols in name table entries .
53,780
def licenses ( family_directory ) : found = [ ] search_paths = [ family_directory ] gitroot = git_rootdir ( family_directory ) if gitroot and gitroot not in search_paths : search_paths . append ( gitroot ) for directory in search_paths : if directory : for license in [ 'OFL.txt' , 'LICENSE.txt' ] : license_path = os . ...
Get a list of paths for every license file found in a font project .
53,781
def com_google_fonts_check_family_has_license ( licenses ) : if len ( licenses ) > 1 : yield FAIL , Message ( "multiple" , ( "More than a single license file found." " Please review." ) ) elif not licenses : yield FAIL , Message ( "no-license" , ( "No license file was found." " Please add an OFL.txt or a LICENSE.txt fi...
Check font has a license .
53,782
def com_google_fonts_check_name_license ( ttFont , license ) : from fontbakery . constants import PLACEHOLDER_LICENSING_TEXT failed = False placeholder = PLACEHOLDER_LICENSING_TEXT [ license ] entry_found = False for i , nameRecord in enumerate ( ttFont [ "name" ] . names ) : if nameRecord . nameID == NameID . LICENSE_...
Check copyright namerecords match license file .
53,783
def com_google_fonts_check_name_license_url ( ttFont , familyname ) : from fontbakery . constants import PLACEHOLDER_LICENSING_TEXT LEGACY_UFL_FAMILIES = [ "Ubuntu" , "UbuntuCondensed" , "UbuntuMono" ] LICENSE_URL = { 'OFL.txt' : 'http://scripts.sil.org/OFL' , 'LICENSE.txt' : 'http://www.apache.org/licenses/LICENSE-2.0...
License URL matches License text on name table?
53,784
def com_google_fonts_check_name_description_max_length ( ttFont ) : failed = False for name in ttFont [ 'name' ] . names : if ( name . nameID == NameID . DESCRIPTION and len ( name . string . decode ( name . getEncoding ( ) ) ) > 200 ) : failed = True break if failed : yield WARN , ( "A few name table entries with ID={...
Description strings in the name table must not exceed 200 characters .
53,785
def com_google_fonts_check_hinting_impact ( font , ttfautohint_stats ) : hinted = ttfautohint_stats [ "hinted_size" ] dehinted = ttfautohint_stats [ "dehinted_size" ] increase = hinted - dehinted change = ( float ( hinted ) / dehinted - 1 ) * 100 def filesize_formatting ( s ) : if s < 1024 : return f"{s} bytes" elif s ...
Show hinting filesize impact .
53,786
def com_google_fonts_check_name_version_format ( ttFont ) : from fontbakery . utils import get_name_entry_strings import re def is_valid_version_format ( value ) : return re . match ( r'Version\s0*[1-9]+\.\d+' , value ) failed = False version_entries = get_name_entry_strings ( ttFont , NameID . VERSION_STRING ) if len ...
Version format is correct in name table?
53,787
def com_google_fonts_check_has_ttfautohint_params ( ttFont ) : from fontbakery . utils import get_name_entry_strings def ttfautohint_version ( value ) : import re results = re . search ( r'ttfautohint \(v(.*)\) ([^;]*)' , value ) if results : return results . group ( 1 ) , results . group ( 2 ) version_strings = get_na...
Font has ttfautohint params?
53,788
def com_google_fonts_check_old_ttfautohint ( ttFont , ttfautohint_stats ) : from fontbakery . utils import get_name_entry_strings def ttfautohint_version ( values ) : import re for value in values : results = re . search ( r'ttfautohint \(v(.*)\)' , value ) if results : return results . group ( 1 ) def installed_versio...
Font has old ttfautohint applied?
53,789
def com_google_fonts_check_gasp ( ttFont ) : if "gasp" not in ttFont . keys ( ) : yield FAIL , ( "Font is missing the 'gasp' table." " Try exporting the font with autohinting enabled." ) else : if not isinstance ( ttFont [ "gasp" ] . gaspRange , dict ) : yield FAIL , "'gasp' table has no values." else : failed = False ...
Is gasp table set to optimize rendering?
53,790
def com_google_fonts_check_name_familyname_first_char ( ttFont ) : from fontbakery . utils import get_name_entry_strings failed = False for familyname in get_name_entry_strings ( ttFont , NameID . FONT_FAMILY_NAME ) : digits = map ( str , range ( 0 , 10 ) ) if familyname [ 0 ] in digits : yield FAIL , ( "Font family na...
Make sure family name does not begin with a digit .
53,791
def com_google_fonts_check_currency_chars ( ttFont ) : def font_has_char ( ttFont , codepoint ) : for subtable in ttFont [ 'cmap' ] . tables : if codepoint in subtable . cmap : return True return False failed = False OPTIONAL = { } MANDATORY = { 0x20AC : "EURO SIGN" } for codepoint , charname in OPTIONAL . items ( ) : ...
Font has all expected currency sign characters?
53,792
def com_google_fonts_check_name_ascii_only_entries ( ttFont ) : bad_entries = [ ] for name in ttFont [ "name" ] . names : if name . nameID == NameID . COPYRIGHT_NOTICE or name . nameID == NameID . POSTSCRIPT_NAME : string = name . string . decode ( name . getEncoding ( ) ) try : string . encode ( 'ascii' ) except : bad...
Are there non - ASCII characters in ASCII - only NAME table entries?
53,793
def com_google_fonts_check_metadata_license ( family_metadata ) : licenses = [ "APACHE2" , "OFL" , "UFL" ] if family_metadata . license in licenses : yield PASS , ( "Font license is declared" " in METADATA.pb as \"{}\"" ) . format ( family_metadata . license ) else : yield FAIL , ( "METADATA.pb license field (\"{}\")" ...
METADATA . pb license is APACHE2 UFL or OFL ?
53,794
def com_google_fonts_check_metadata_menu_and_latin ( family_metadata ) : missing = [ ] for s in [ "menu" , "latin" ] : if s not in list ( family_metadata . subsets ) : missing . append ( s ) if missing != [ ] : yield FAIL , ( "Subsets \"menu\" and \"latin\" are mandatory," " but METADATA.pb is missing" " \"{}\"" ) . fo...
METADATA . pb should contain at least menu and latin subsets .
53,795
def com_google_fonts_check_metadata_subsets_order ( family_metadata ) : expected = list ( sorted ( family_metadata . subsets ) ) if list ( family_metadata . subsets ) != expected : yield FAIL , ( "METADATA.pb subsets are not sorted " "in alphabetical order: Got ['{}']" " and expected ['{}']" ) . format ( "', '" . join ...
METADATA . pb subsets should be alphabetically ordered .
53,796
def com_google_fonts_check_metadata_familyname ( family_metadata ) : name = "" fail = False for f in family_metadata . fonts : if name and f . name != name : fail = True name = f . name if fail : yield FAIL , ( "METADATA.pb: Family name is not the same" " in all metadata \"fonts\" items." ) else : yield PASS , ( "METAD...
Check that METADATA . pb family values are all the same .
53,797
def com_google_fonts_check_metadata_nameid_family_name ( ttFont , font_metadata ) : from fontbakery . utils import get_name_entry_strings familynames = get_name_entry_strings ( ttFont , NameID . TYPOGRAPHIC_FAMILY_NAME ) if not familynames : familynames = get_name_entry_strings ( ttFont , NameID . FONT_FAMILY_NAME ) if...
Checks METADATA . pb font . name field matches family name declared on the name table .
53,798
def com_google_fonts_check_metadata_nameid_post_script_name ( ttFont , font_metadata ) : failed = False from fontbakery . utils import get_name_entry_strings postscript_names = get_name_entry_strings ( ttFont , NameID . POSTSCRIPT_NAME ) if len ( postscript_names ) == 0 : failed = True yield FAIL , Message ( "missing" ...
Checks METADATA . pb font . post_script_name matches postscript name declared on the name table .
53,799
def com_google_fonts_check_metadata_nameid_full_name ( ttFont , font_metadata ) : from fontbakery . utils import get_name_entry_strings full_fontnames = get_name_entry_strings ( ttFont , NameID . FULL_FONT_NAME ) if len ( full_fontnames ) == 0 : yield FAIL , Message ( "lacks-entry" , ( "This font lacks a FULL_FONT_NAME...
METADATA . pb font . full_name value matches fullname declared on the name table?