1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
|
import dataclasses
import re
import typing
from graphviz import Digraph
import babelfont
from babelfont import *
from babelfont.BaseObject import I18NDictionary
tocfile = open("docs/_data/navigation.yml", "w")
tocfile.write("default:\n")
def maybelink(t):
if "babelfont" in str(t) and dataclasses.is_dataclass(t):
return "[`%s`](%s.html)" % (t.__name__, t.__name__)
if isinstance(t, typing._GenericAlias):
if t._name == "Optional":
return "Optional[%s]" % maybelink(t.__args__[0])
elif t._name == "List":
return "[%s]" % maybelink(t.__args__[0])
if isinstance(t, tuple):
return "(" + ", ".join([e.__name__ for e in t]) + ")"
return t.__name__
def describe_dataclass(cls):
if not dataclasses.is_dataclass(cls):
return
name = cls.__name__
f = open("docs/%s.md" % name, "w")
tocfile.write(" - title: %s\n url: %s.html\n" % (name, name))
f.write("---\ntitle: %s\n---\n" % name)
f.write(cls.__doc__)
f.write("\n")
if cls._write_one_line:
f.write(
"* When writing to Babelfont-JSON, this class must be serialized without newlines\n"
)
for k in dataclasses.fields(cls):
if k.name == "_":
continue
if isinstance(k.type, list):
stringytype = "[%s]" % ", ".join([maybelink(t) for t in k.type])
elif isinstance(k.type, tuple):
stringytype = "(%s)" % ", ".join([maybelink(t) for t in k.type])
else:
stringytype = maybelink(k.type)
if not "`" in stringytype:
stringytype = "`%s`" % stringytype
f.write("## %s.%s\n\n" % (name, k.name))
f.write("* Python type: %s\n\n" % stringytype)
if "json_type" in k.metadata:
f.write("* Babelfont-JSON type: `%s`\n\n" % k.metadata["json_type"])
if (
k.default is dataclasses.MISSING
and k.default_factory is dataclasses.MISSING
):
f.write("* **Required field**\n\n")
if "json_location" in k.metadata:
f.write(
"* When writing to Babelfont-JSON, this structure is stored under the separate file `%s`.\n\n"
% k.metadata["json_location"]
)
if "separate_items" in k.metadata:
f.write(
"* When writing to Babelfont-JSON, each item in the list must be placed on a separate line.\n\n"
)
if "python_only" in k.metadata:
f.write(
"* This field only exists as an attribute of the the Python object and should not be written to Babelfont-JSON.\n\n"
)
if "description" in k.metadata:
f.write(k.metadata["description"])
if k.type == I18NDictionary:
f.write(" *Localizable.*")
f.write("\n")
if k.default is not dataclasses.MISSING:
f.write("*If not provided, defaults to* `%s`.\n" % str(k.default))
f.write("\n\n")
f.close()
describe_dataclass(Font)
describe_dataclass(Axis)
describe_dataclass(Instance)
describe_dataclass(Master)
describe_dataclass(Names)
describe_dataclass(Glyph)
describe_dataclass(Layer)
describe_dataclass(Guide)
describe_dataclass(Shape)
describe_dataclass(Anchor)
dot = Digraph(comment="Babelfont Format", format="svg")
dot.attr(rankdir="LR")
dot.attr(overlap="false")
donetypes = {}
def add_type_node(cls):
def chktype(t, port):
if "babelfont" in str(t) and dataclasses.is_dataclass(t):
add_type_node(t)
dot.edge(cls.__name__ + ":" + port, t.__name__)
if isinstance(t, tuple):
return "(" + ", ".join([e.__name__ for e in t]) + ")"
return t.__name__
if cls in donetypes:
return
if not dataclasses.is_dataclass(cls):
return
label = (
"""<<TABLE>
<tr><td colspan="2" border="0"><b>%s</b></td></tr>
"""
% cls.__name__
)
for k in dataclasses.fields(cls):
if k.name == "_" or "python_only" in k.metadata:
continue
if isinstance(k.type, list):
stringytype = "[%s]" % ", ".join([chktype(t, k.name) for t in k.type])
elif isinstance(k.type, tuple):
stringytype = "(%s)" % ", ".join([chktype(t, k.name) for t in k.type])
else:
stringytype = chktype(k.type, k.name)
name = k.name
if (
k.default is dataclasses.MISSING
and k.default_factory is dataclasses.MISSING
):
name = "<b>%s</b>" % name
label = label + '<tr><td>%s</td><td port="%s"><i>%s</i></td></tr>' % (
name,
k.name,
stringytype,
)
label = label + "</TABLE>>"
dot.node(
cls.__name__,
label,
shape="none",
fontname="Avenir",
href="%s.html" % cls.__name__,
)
donetypes[cls] = True
add_type_node(Font)
add_type_node(Glyph)
dot.edge("Font:glyphs", "Glyph")
output = re.sub(r"(?s)^.*<svg", "<svg", dot.pipe().decode("utf-8"))
out = open("docs/index.md", "w")
out.write(
"""---
title: Babelfont Format
toc: false
---
"""
)
out.write(output + "\n")
|
