matplotlib/lib/matplotlib/font_manager.py at 65e54afa2f11437e341539c30e27ab3101100e0c · matplotlib/matplotlib

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

"""

A module for finding, managing, and using fonts across platforms.

This module provides a single `FontManager` instance, ``fontManager``, that can

be shared across backends and platforms. The `findfont`

function returns the best TrueType (TTF) font file in the local or

system font path that matches the specified `FontProperties`

instance. The `FontManager` also handles Adobe Font Metrics

(AFM) font files for use by the PostScript backend.

The design is based on the `W3C Cascading Style Sheet, Level 1 (CSS1)

font specification <http://www.w3.org/TR/1998/REC-CSS2-19980512/>`_.

Future versions may implement the Level 2 or 2.1 specifications.

"""

# KNOWN ISSUES

# - documentation

# - font variant is untested

# - font stretch is incomplete

# - font size is incomplete

# - default font algorithm needs improvement and testing

# - setWeights function needs improvement

# - 'light' is an invalid weight value, remove it.

from base64 import b64encode

import copy

import dataclasses

from functools import lru_cache

from io import BytesIO

import json

import logging

from numbers import Number

import os

from pathlib import Path

import re

import subprocess

import sys

import threading

import matplotlib as mpl

from matplotlib import _api, _afm, cbook, ft2font

from matplotlib._fontconfig_pattern import (

parse_fontconfig_pattern, generate_fontconfig_pattern)

from matplotlib.rcsetup import _validators

_log = logging.getLogger(__name__)

font_scalings = {

'xx-small': 0.579,

'x-small': 0.694,

'small': 0.833,

'medium': 1.0,

'large': 1.200,

'x-large': 1.440,

'xx-large': 1.728,

'larger': 1.2,

'smaller': 0.833,

None: 1.0,

}

stretch_dict = {

'ultra-condensed': 100,

'extra-condensed': 200,

'condensed': 300,

'semi-condensed': 400,

'normal': 500,

'semi-expanded': 600,

'semi-extended': 600,

'expanded': 700,

'extended': 700,

'extra-expanded': 800,

'extra-extended': 800,

'ultra-expanded': 900,

'ultra-extended': 900,

}

weight_dict = {

'ultralight': 100,

'light': 200,

'normal': 400,

'regular': 400,

'book': 400,

'medium': 500,

'roman': 500,

'semibold': 600,

'demibold': 600,

'demi': 600,

'bold': 700,

'heavy': 800,

'extra bold': 800,

'black': 900,

}

_weight_regexes = [

# From fontconfig's FcFreeTypeQueryFaceInternal; not the same as

# weight_dict!

("thin", 100),

("extralight", 200),

("ultralight", 200),

("demilight", 350),

("semilight", 350),

("light", 300), # Needs to come *after* demi/semilight!

("book", 380),

("regular", 400),

("normal", 400),

("medium", 500),

("demibold", 600),

("demi", 600),

("semibold", 600),

("extrabold", 800),

("superbold", 800),

("ultrabold", 800),

("bold", 700), # Needs to come *after* extra/super/ultrabold!

("ultrablack", 1000),

("superblack", 1000),

("extrablack", 1000),

(r"\bultra", 1000),

("black", 900), # Needs to come *after* ultra/super/extrablack!

("heavy", 900),

]

font_family_aliases = {

'serif',

'sans-serif',

'sans serif',

'cursive',

'fantasy',

'monospace',

'sans',

}

# OS Font paths

try:

_HOME = Path.home()

except Exception: # Exceptions thrown by home() are not specified...

_HOME = Path(os.devnull) # Just an arbitrary path with no children.

MSFolders = \

r'Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders'

MSFontDirectories = [

r'SOFTWARE\Microsoft\Windows NT\CurrentVersion\Fonts',

r'SOFTWARE\Microsoft\Windows\CurrentVersion\Fonts']

MSUserFontDirectories = [

str(_HOME / 'AppData/Local/Microsoft/Windows/Fonts'),

str(_HOME / 'AppData/Roaming/Microsoft/Windows/Fonts'),

]

X11FontDirectories = [

# an old standard installation point

"/usr/X11R6/lib/X11/fonts/TTF/",

"/usr/X11/lib/X11/fonts",

# here is the new standard location for fonts

"/usr/share/fonts/",

# documented as a good place to install new fonts

"/usr/local/share/fonts/",

# common application, not really useful

"/usr/lib/openoffice/share/fonts/truetype/",

# user fonts

str((Path(os.environ.get('XDG_DATA_HOME') or _HOME / ".local/share"))

/ "fonts"),

str(_HOME / ".fonts"),

]

OSXFontDirectories = [

"/Library/Fonts/",

"/Network/Library/Fonts/",

"/System/Library/Fonts/",

# fonts installed via MacPorts

"/opt/local/share/fonts",

# user fonts

str(_HOME / "Library/Fonts"),

]

def get_fontext_synonyms(fontext):

"""

Return a list of file extensions that are synonyms for

the given file extension *fileext*.

"""

return {

'afm': ['afm'],

'otf': ['otf', 'ttc', 'ttf'],

'ttc': ['otf', 'ttc', 'ttf'],

'ttf': ['otf', 'ttc', 'ttf'],

}[fontext]

def list_fonts(directory, extensions):

"""

Return a list of all fonts matching any of the extensions, found

recursively under the directory.

"""

extensions = ["." + ext for ext in extensions]

if sys.platform == 'win32' and directory == win32FontDirectory():

return [os.path.join(directory, filename)

for filename in os.listdir(directory)

if os.path.isfile(os.path.join(directory, filename))]

else:

return [os.path.join(dirpath, filename)

# os.walk ignores access errors, unlike Path.glob.

for dirpath, _, filenames in os.walk(directory)

for filename in filenames

if Path(filename).suffix.lower() in extensions]

def win32FontDirectory():

r"""

Return the user-specified font directory for Win32. This is

looked up from the registry key ::

\\HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders\Fonts

If the key is not found, ``%WINDIR%\Fonts`` will be returned.

"""

import winreg

try:

with winreg.OpenKey(winreg.HKEY_CURRENT_USER, MSFolders) as user:

return winreg.QueryValueEx(user, 'Fonts')[0]

except OSError:

return os.path.join(os.environ['WINDIR'], 'Fonts')

def _get_win32_installed_fonts():

"""List the font paths known to the Windows registry."""

import winreg

items = set()

# Search and resolve fonts listed in the registry.

for domain, base_dirs in [

(winreg.HKEY_LOCAL_MACHINE, [win32FontDirectory()]), # System.

(winreg.HKEY_CURRENT_USER, MSUserFontDirectories), # User.

for base_dir in base_dirs:

for reg_path in MSFontDirectories:

try:

with winreg.OpenKey(domain, reg_path) as local:

for j in range(winreg.QueryInfoKey(local)[1]):

# value may contain the filename of the font or its

# absolute path.

key, value, tp = winreg.EnumValue(local, j)

if not isinstance(value, str):

continue

try:

# If value contains already an absolute path,

# then it is not changed further.

path = Path(base_dir, value).resolve()

except RuntimeError:

# Don't fail with invalid entries.

continue

items.add(path)

except (OSError, MemoryError):

continue

return items

@lru_cache()

def _get_fontconfig_fonts():

"""Cache and list the font paths known to ``fc-list``."""

try:

if b'--format' not in subprocess.check_output(['fc-list', '--help']):

_log.warning( # fontconfig 2.7 implemented --format.

'Matplotlib needs fontconfig>=2.7 to query system fonts.')

return []

out = subprocess.check_output(['fc-list', '--format=%{file}\\n'])

except (OSError, subprocess.CalledProcessError):

return []

return [Path(os.fsdecode(fname)) for fname in out.split(b'\n')]

def findSystemFonts(fontpaths=None, fontext='ttf'):

"""

Search for fonts in the specified font paths. If no paths are

given, will use a standard set of system paths, as well as the

list of fonts tracked by fontconfig if fontconfig is installed and

available. A list of TrueType fonts are returned by default with

AFM fonts as an option.

"""

fontfiles = set()

fontexts = get_fontext_synonyms(fontext)

if fontpaths is None:

if sys.platform == 'win32':

installed_fonts = _get_win32_installed_fonts()

fontpaths = MSUserFontDirectories + [win32FontDirectory()]

else:

installed_fonts = _get_fontconfig_fonts()

if sys.platform == 'darwin':

fontpaths = [*X11FontDirectories, *OSXFontDirectories]

else:

fontpaths = X11FontDirectories

fontfiles.update(str(path) for path in installed_fonts

if path.suffix.lower()[1:] in fontexts)

elif isinstance(fontpaths, str):

fontpaths = [fontpaths]

for path in fontpaths:

fontfiles.update(map(os.path.abspath, list_fonts(path, fontexts)))

return [fname for fname in fontfiles if os.path.exists(fname)]

def _fontentry_helper_repr_png(fontent):

from matplotlib.figure import Figure # Circular import.

fig = Figure()

font_path = Path(fontent.fname) if fontent.fname != '' else None

fig.text(0, 0, fontent.name, font=font_path)

with BytesIO() as buf:

fig.savefig(buf, bbox_inches='tight', transparent=True)

return buf.getvalue()

def _fontentry_helper_repr_html(fontent):

png_stream = _fontentry_helper_repr_png(fontent)

png_b64 = b64encode(png_stream).decode()

return f"<img src=\"data:image/png;base64, {png_b64}\" />"

FontEntry = dataclasses.make_dataclass(

'FontEntry', [

('fname', str, dataclasses.field(default='')),

('name', str, dataclasses.field(default='')),

('style', str, dataclasses.field(default='normal')),

('variant', str, dataclasses.field(default='normal')),

('weight', str, dataclasses.field(default='normal')),

('stretch', str, dataclasses.field(default='normal')),

('size', str, dataclasses.field(default='medium')),

namespace={

'__doc__': """

A class for storing Font properties.

It is used when populating the font lookup dictionary.

""",

'_repr_html_': lambda self: _fontentry_helper_repr_html(self),

'_repr_png_': lambda self: _fontentry_helper_repr_png(self),

}

)

def ttfFontProperty(font):

"""

Extract information from a TrueType font file.

Parameters

----------

font : `.FT2Font`

The TrueType font file from which information will be extracted.

Returns

-------

`FontEntry`

The extracted font properties.

"""

name = font.family_name

# Styles are: italic, oblique, and normal (default)

sfnt = font.get_sfnt()

mac_key = (1, # platform: macintosh

0, # id: roman

0) # langid: english

ms_key = (3, # platform: microsoft

1, # id: unicode_cs

0x0409) # langid: english_united_states

# These tables are actually mac_roman-encoded, but mac_roman support may be

# missing in some alternative Python implementations and we are only going

# to look for ASCII substrings, where any ASCII-compatible encoding works

# - or big-endian UTF-16, since important Microsoft fonts use that.

sfnt2 = (sfnt.get((*mac_key, 2), b'').decode('latin-1').lower() or

sfnt.get((*ms_key, 2), b'').decode('utf_16_be').lower())

sfnt4 = (sfnt.get((*mac_key, 4), b'').decode('latin-1').lower() or

sfnt.get((*ms_key, 4), b'').decode('utf_16_be').lower())

if sfnt4.find('oblique') >= 0:

style = 'oblique'

elif sfnt4.find('italic') >= 0:

style = 'italic'

elif sfnt2.find('regular') >= 0:

style = 'normal'

elif font.style_flags & ft2font.ITALIC:

style = 'italic'

else:

style = 'normal'

# Variants are: small-caps and normal (default)

# !!!! Untested

if name.lower() in ['capitals', 'small-caps']:

variant = 'small-caps'

else:

variant = 'normal'

# The weight-guessing algorithm is directly translated from fontconfig

# 2.13.1's FcFreeTypeQueryFaceInternal (fcfreetype.c).

wws_subfamily = 22

typographic_subfamily = 16

font_subfamily = 2

styles = [

sfnt.get((*mac_key, wws_subfamily), b'').decode('latin-1'),

sfnt.get((*mac_key, typographic_subfamily), b'').decode('latin-1'),

sfnt.get((*mac_key, font_subfamily), b'').decode('latin-1'),

sfnt.get((*ms_key, wws_subfamily), b'').decode('utf-16-be'),

sfnt.get((*ms_key, typographic_subfamily), b'').decode('utf-16-be'),

sfnt.get((*ms_key, font_subfamily), b'').decode('utf-16-be'),

]

styles = [*filter(None, styles)] or [font.style_name]

def get_weight(): # From fontconfig's FcFreeTypeQueryFaceInternal.

# OS/2 table weight.

os2 = font.get_sfnt_table("OS/2")

if os2 and os2["version"] != 0xffff:

return os2["usWeightClass"]

# PostScript font info weight.

try:

ps_font_info_weight = (

font.get_ps_font_info()["weight"].replace(" ", "") or "")

except ValueError:

pass

else:

for regex, weight in _weight_regexes:

if re.fullmatch(regex, ps_font_info_weight, re.I):

return weight

# Style name weight.

for style in styles:

style = style.replace(" ", "")

for regex, weight in _weight_regexes:

if re.search(regex, style, re.I):

return weight

if font.style_flags & ft2font.BOLD:

return 700 # "bold"

return 500 # "medium", not "regular"!

weight = int(get_weight())

# Stretch can be absolute and relative

# Absolute stretches are: ultra-condensed, extra-condensed, condensed,

# semi-condensed, normal, semi-expanded, expanded, extra-expanded,

# and ultra-expanded.

# Relative stretches are: wider, narrower

# Child value is: inherit

if any(word in sfnt4 for word in ['narrow', 'condensed', 'cond']):

stretch = 'condensed'

elif 'demi cond' in sfnt4:

stretch = 'semi-condensed'

elif any(word in sfnt4 for word in ['wide', 'expanded', 'extended']):

stretch = 'expanded'

else:

stretch = 'normal'

# Sizes can be absolute and relative.

# Absolute sizes are: xx-small, x-small, small, medium, large, x-large,

# and xx-large.

# Relative sizes are: larger, smaller

# Length value is an absolute font size, e.g., 12pt

# Percentage values are in 'em's. Most robust specification.

if not font.scalable:

raise NotImplementedError("Non-scalable fonts are not supported")

size = 'scalable'

return FontEntry(font.fname, name, style, variant, weight, stretch, size)

def afmFontProperty(fontpath, font):

"""

Extract information from an AFM font file.

Parameters

----------

font : AFM

The AFM font file from which information will be extracted.

Returns

-------

`FontEntry`

The extracted font properties.

"""

name = font.get_familyname()

fontname = font.get_fontname().lower()

# Styles are: italic, oblique, and normal (default)

if font.get_angle() != 0 or 'italic' in name.lower():

style = 'italic'

elif 'oblique' in name.lower():

style = 'oblique'

else:

style = 'normal'

# Variants are: small-caps and normal (default)

# !!!! Untested

if name.lower() in ['capitals', 'small-caps']:

variant = 'small-caps'

else:

variant = 'normal'

weight = font.get_weight().lower()

if weight not in weight_dict:

weight = 'normal'

# Stretch can be absolute and relative

# Absolute stretches are: ultra-condensed, extra-condensed, condensed,

# semi-condensed, normal, semi-expanded, expanded, extra-expanded,

# and ultra-expanded.

# Relative stretches are: wider, narrower

# Child value is: inherit

if 'demi cond' in fontname:

stretch = 'semi-condensed'

elif any(word in fontname for word in ['narrow', 'cond']):

stretch = 'condensed'

elif any(word in fontname for word in ['wide', 'expanded', 'extended']):

stretch = 'expanded'

else:

stretch = 'normal'

# Sizes can be absolute and relative.

# Absolute sizes are: xx-small, x-small, small, medium, large, x-large,

# and xx-large.

# Relative sizes are: larger, smaller

# Length value is an absolute font size, e.g., 12pt

# Percentage values are in 'em's. Most robust specification.

# All AFM fonts are apparently scalable.

size = 'scalable'

return FontEntry(fontpath, name, style, variant, weight, stretch, size)

class FontProperties:

"""

A class for storing and manipulating font properties.

The font properties are the six properties described in the

`W3C Cascading Style Sheet, Level 1

<http://www.w3.org/TR/1998/REC-CSS2-19980512/>`_ font

specification and *math_fontfamily* for math fonts:

- family: A list of font names in decreasing order of priority.

The items may include a generic font family name, either 'sans-serif',

'serif', 'cursive', 'fantasy', or 'monospace'. In that case, the actual

font to be used will be looked up from the associated rcParam during the

search process in `.findfont`. Default: :rc:`font.family`

- style: Either 'normal', 'italic' or 'oblique'.

Default: :rc:`font.style`

- variant: Either 'normal' or 'small-caps'.

Default: :rc:`font.variant`

- stretch: A numeric value in the range 0-1000 or one of

'ultra-condensed', 'extra-condensed', 'condensed',

'semi-condensed', 'normal', 'semi-expanded', 'expanded',

'extra-expanded' or 'ultra-expanded'. Default: :rc:`font.stretch`

- weight: A numeric value in the range 0-1000 or one of

'ultralight', 'light', 'normal', 'regular', 'book', 'medium',

'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy',

'extra bold', 'black'. Default: :rc:`font.weight`

- size: Either a relative value of 'xx-small', 'x-small',

'small', 'medium', 'large', 'x-large', 'xx-large' or an

absolute font size, e.g., 10. Default: :rc:`font.size`

- math_fontfamily: The family of fonts used to render math text.

Supported values are: 'dejavusans', 'dejavuserif', 'cm',

'stix', 'stixsans' and 'custom'. Default: :rc:`mathtext.fontset`

Alternatively, a font may be specified using the absolute path to a font

file, by using the *fname* kwarg. However, in this case, it is typically

simpler to just pass the path (as a `pathlib.Path`, not a `str`) to the

*font* kwarg of the `.Text` object.

The preferred usage of font sizes is to use the relative values,

e.g., 'large', instead of absolute font sizes, e.g., 12. This

approach allows all text sizes to be made larger or smaller based

on the font manager's default font size.

This class will also accept a fontconfig_ pattern_, if it is the only

argument provided. This support does not depend on fontconfig; we are

merely borrowing its pattern syntax for use here.

.. _fontconfig: https://www.freedesktop.org/wiki/Software/fontconfig/

.. _pattern:

https://www.freedesktop.org/software/fontconfig/fontconfig-user.html

Note that Matplotlib's internal font manager and fontconfig use a

different algorithm to lookup fonts, so the results of the same pattern

may be different in Matplotlib than in other applications that use

fontconfig.

"""

def __init__(self, family=None, style=None, variant=None, weight=None,

stretch=None, size=None,

fname=None, # if set, it's a hardcoded filename to use

math_fontfamily=None):

self.set_family(family)

self.set_style(style)

self.set_variant(variant)

self.set_weight(weight)

self.set_stretch(stretch)

self.set_file(fname)

self.set_size(size)

self.set_math_fontfamily(math_fontfamily)

# Treat family as a fontconfig pattern if it is the only parameter

# provided. Even in that case, call the other setters first to set

# attributes not specified by the pattern to the rcParams defaults.

if (isinstance(family, str)

and style is None and variant is None and weight is None

and stretch is None and size is None and fname is None):

self.set_fontconfig_pattern(family)

@classmethod

def _from_any(cls, arg):

"""

Generic constructor which can build a `.FontProperties` from any of the

following:

- a `.FontProperties`: it is passed through as is;

- `None`: a `.FontProperties` using rc values is used;

- an `os.PathLike`: it is used as path to the font file;

- a `str`: it is parsed as a fontconfig pattern;

- a `dict`: it is passed as ``**kwargs`` to `.FontProperties`.

"""

if isinstance(arg, cls):

return arg

elif arg is None:

return cls()

elif isinstance(arg, os.PathLike):

return cls(fname=arg)

elif isinstance(arg, str):

return cls(arg)

else:

return cls(**arg)

def __hash__(self):

l = (tuple(self.get_family()),

self.get_slant(),

self.get_variant(),

self.get_weight(),

self.get_stretch(),

self.get_size(),

self.get_file(),

self.get_math_fontfamily())

return hash(l)

def __eq__(self, other):

return hash(self) == hash(other)

def __str__(self):

return self.get_fontconfig_pattern()

def get_family(self):

"""

Return a list of individual font family names or generic family names.

The font families or generic font families (which will be resolved

from their respective rcParams when searching for a matching font) in

the order of preference.

"""

return self._family

def get_name(self):

"""

Return the name of the font that best matches the font properties.

"""

return get_font(findfont(self)).family_name

def get_style(self):

"""

Return the font style. Values are: 'normal', 'italic' or 'oblique'.

"""

return self._slant

def get_variant(self):

"""

Return the font variant. Values are: 'normal' or 'small-caps'.

"""

return self._variant

def get_weight(self):

"""

Set the font weight. Options are: A numeric value in the

range 0-1000 or one of 'light', 'normal', 'regular', 'book',

'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold',

'heavy', 'extra bold', 'black'

"""

return self._weight

def get_stretch(self):

"""

Return the font stretch or width. Options are: 'ultra-condensed',

'extra-condensed', 'condensed', 'semi-condensed', 'normal',

'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'.

"""

return self._stretch

def get_size(self):

"""

Return the font size.

"""

return self._size

def get_file(self):

"""

Return the filename of the associated font.

"""

return self._file

def get_fontconfig_pattern(self):

"""

Get a fontconfig_ pattern_ suitable for looking up the font as

specified with fontconfig's ``fc-match`` utility.

This support does not depend on fontconfig; we are merely borrowing its

pattern syntax for use here.

"""

return generate_fontconfig_pattern(self)

def set_family(self, family):

"""

Change the font family. Can be either an alias (generic name

is CSS parlance), such as: 'serif', 'sans-serif', 'cursive',

'fantasy', or 'monospace', a real font name or a list of real

font names. Real font names are not supported when

:rc:`text.usetex` is `True`. Default: :rc:`font.family`

"""

if family is None:

family = mpl.rcParams['font.family']

if isinstance(family, str):

family = [family]

self._family = family

def set_style(self, style):

"""

Set the font style.

Parameters

----------

style : {'normal', 'italic', 'oblique'}, default: :rc:`font.style`

"""

if style is None:

style = mpl.rcParams['font.style']

_api.check_in_list(['normal', 'italic', 'oblique'], style=style)

self._slant = style

def set_variant(self, variant):

"""

Set the font variant.

Parameters

----------

variant : {'normal', 'small-caps'}, default: :rc:`font.variant`

"""

if variant is None:

variant = mpl.rcParams['font.variant']

_api.check_in_list(['normal', 'small-caps'], variant=variant)

self._variant = variant

def set_weight(self, weight):

"""

Set the font weight.

Parameters

----------

weight : int or {'ultralight', 'light', 'normal', 'regular', 'book', \

'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', \

'extra bold', 'black'}, default: :rc:`font.weight`

If int, must be in the range 0-1000.

"""

if weight is None:

weight = mpl.rcParams['font.weight']

if weight in weight_dict:

self._weight = weight

return

try:

weight = int(weight)

except ValueError:

pass

else:

if 0 <= weight <= 1000:

self._weight = weight

return

raise ValueError(f"{weight=} is invalid")

def set_stretch(self, stretch):

"""

Set the font stretch or width.

Parameters

----------

stretch : int or {'ultra-condensed', 'extra-condensed', 'condensed', \

'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', \

'ultra-expanded'}, default: :rc:`font.stretch`

If int, must be in the range 0-1000.

"""

if stretch is None:

stretch = mpl.rcParams['font.stretch']

if stretch in stretch_dict:

self._stretch = stretch

return

try:

stretch = int(stretch)

except ValueError:

pass

else:

if 0 <= stretch <= 1000:

self._stretch = stretch

return

raise ValueError(f"{stretch=} is invalid")

def set_size(self, size):

"""

Set the font size.

Parameters

----------

size : float or {'xx-small', 'x-small', 'small', 'medium', \

'large', 'x-large', 'xx-large'}, default: :rc:`font.size`

If a float, the font size in points. The string values denote

sizes relative to the default font size.

"""

if size is None:

size = mpl.rcParams['font.size']

try:

size = float(size)

except ValueError:

try:

scale = font_scalings[size]

except KeyError as err:

raise ValueError(

"Size is invalid. Valid font size are "

+ ", ".join(map(str, font_scalings))) from err

else:

size = scale * FontManager.get_default_size()

if size < 1.0:

_log.info('Fontsize %1.2f < 1.0 pt not allowed by FreeType. '

'Setting fontsize = 1 pt', size)

size = 1.0

self._size = size

def set_file(self, file):

"""

Set the filename of the fontfile to use. In this case, all

other properties will be ignored.

"""

self._file = os.fspath(file) if file is not None else None

def set_fontconfig_pattern(self, pattern):

"""

Set the properties by parsing a fontconfig_ *pattern*.

This support does not depend on fontconfig; we are merely borrowing its

pattern syntax for use here.

"""

for key, val in parse_fontconfig_pattern(pattern).items():

if type(val) == list:

getattr(self, "set_" + key)(val[0])

else:

getattr(self, "set_" + key)(val)

def get_math_fontfamily(self):

"""

Return the name of the font family used for math text.

The default font is :rc:`mathtext.fontset`.

"""

return self._math_fontfamily

def set_math_fontfamily(self, fontfamily):

"""

Set the font family for text in math mode.

If not set explicitly, :rc:`mathtext.fontset` will be used.

Parameters

----------

fontfamily : str

The name of the font family.

Available font families are defined in the

matplotlibrc.template file

:ref:`here <customizing-with-matplotlibrc-files>`

FilesExpand file tree

font_manager.py

Latest commit

History

font_manager.py

File metadata and controls