/
test_text.py
273 lines (234 loc) · 6.34 KB
/
test_text.py
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
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
# pylint: disable=redefined-outer-name
"""
Tests text
"""
import os
import pytest
from .. import Figure
from ..exceptions import GMTInvalidInput
from ..helpers import GMTTempFile
TEST_DATA_DIR = os.path.join(os.path.dirname(__file__), "data")
POINTS_DATA = os.path.join(TEST_DATA_DIR, "points.txt")
CITIES_DATA = os.path.join(TEST_DATA_DIR, "cities.txt")
@pytest.fixture(scope="module")
def projection():
"The projection system"
return "x4i"
@pytest.fixture(scope="module")
def region():
"The data region"
return [0, 5, 0, 2.5]
@pytest.mark.mpl_image_compare
def test_text_single_line_of_text(region, projection):
"""
Place a single line text of text at some x, y location
"""
fig = Figure()
fig.text(
region=region,
projection=projection,
x=1.2,
y=2.4,
text="This is a line of text",
)
return fig
@pytest.mark.mpl_image_compare
def test_text_multiple_lines_of_text(region, projection):
"""
Place multiple lines of text at their respective x, y locations
"""
fig = Figure()
fig.text(
region=region,
projection=projection,
x=[1.2, 1.6],
y=[0.6, 0.3],
text=["This is a line of text", "This is another line of text"],
)
return fig
def test_text_without_text_input(region, projection):
"""
Run text by passing in x and y, but no text
"""
fig = Figure()
with pytest.raises(GMTInvalidInput):
fig.text(region=region, projection=projection, x=1.2, y=2.4)
@pytest.mark.mpl_image_compare
def test_text_input_single_filename():
"""
Run text by passing in one filename to textfiles
"""
fig = Figure()
fig.text(region=[10, 70, -5, 10], textfiles=POINTS_DATA)
return fig
@pytest.mark.mpl_image_compare
def test_text_input_multiple_filenames():
"""
Run text by passing in multiple filenames to textfiles
"""
fig = Figure()
fig.text(region=[10, 70, -30, 10], textfiles=[POINTS_DATA, CITIES_DATA])
return fig
def test_text_nonexistent_filename():
"""
Run text by passing in a list of filenames with one that does not exist
"""
fig = Figure()
with pytest.raises(GMTInvalidInput):
fig.text(region=[10, 70, -5, 10], textfiles=[POINTS_DATA, "notexist.txt"])
@pytest.mark.mpl_image_compare
def test_text_position_four_corners(region):
"""
Print text at four corners (top left/right, bottom left/right) of map.
"""
fig = Figure()
for position in ("TL", "TR", "BL", "BR"):
fig.text(
region=region, projection="x1c", frame="a", position=position, text=position
)
return fig
def test_text_xy_with_position_fails(region, projection):
"""
Run text by providing both x/y pairs and position arguments.
"""
fig = Figure()
with pytest.raises(GMTInvalidInput):
fig.text(
region=region, projection="x1c", x=1.2, y=2.4, position="MC", text="text"
)
@pytest.mark.mpl_image_compare
def test_text_angle_30(region, projection):
"""
Print text at 30 degrees counter-clockwise from horizontal
"""
fig = Figure()
fig.text(
region=region,
projection=projection,
x=1.2,
y=2.4,
text="text angle 30 degrees",
angle=30,
)
return fig
@pytest.mark.mpl_image_compare
def test_text_font_bold(region, projection):
"""
Print text with a bold font
"""
fig = Figure()
fig.text(
region=region,
projection=projection,
x=1.2,
y=2.4,
text="text in bold",
font="Helvetica-Bold",
)
return fig
@pytest.mark.mpl_image_compare
def test_text_fill(region, projection):
"""
Print text with blue color fill
"""
fig = Figure()
fig.text(
region=region,
projection=projection,
x=1.2,
y=1.2,
text="blue fill around text",
fill="blue",
)
return fig
@pytest.mark.mpl_image_compare
def test_text_pen(region, projection):
"""
Print text with thick green dashed pen
"""
fig = Figure()
fig.text(
region=region,
projection=projection,
x=1.2,
y=1.2,
text="green pen around text",
pen="thick,green,dashed",
)
return fig
@pytest.mark.mpl_image_compare
def test_text_round_clearance(region, projection):
"""
Print text with round rectangle box clearance
"""
fig = Figure()
fig.text(
region=region,
projection=projection,
x=1.2,
y=1.2,
text="clearance around text",
clearance="90%+tO",
pen="default,black,dashed",
)
return fig
@pytest.mark.mpl_image_compare
def test_text_justify_bottom_right_and_top_left(region, projection):
"""
Print text justified at bottom right and top left
"""
fig = Figure()
fig.text(
region=region,
projection=projection,
x=1.2,
y=0.2,
text="text justified bottom right",
justify="BR",
)
fig.text(
region=region,
projection=projection,
x=1.2,
y=0.2,
text="text justified top left",
justify="TL",
)
return fig
@pytest.mark.mpl_image_compare
def test_text_justify_parsed_from_textfile():
"""
Print text justified based on a column from textfile, using justify=True
boolean operation. Loosely based on "All great-circle paths lead to Rome"
gallery example at
https://gmt.soest.hawaii.edu/doc/latest/gallery/ex23.html
"""
fig = Figure()
fig.text(
region="g",
projection="H90/9i",
justify=True,
textfiles=CITIES_DATA,
D="j0.45/0+vred", # draw red-line from xy point to text label (city name)
)
return fig
@pytest.mark.mpl_image_compare
def test_text_angle_font_justify_from_textfile(region, projection):
"""
Print text with x, y, angle, font, justify, and text arguments parsed from
the textfile.
"""
fig = Figure()
with GMTTempFile(suffix=".txt") as tempfile:
with open(tempfile.name, "w") as tmpfile:
tmpfile.write("114 0.5 30 22p,Helvetica-Bold,black LM BORNEO")
fig.text(
region=[113, 117.5, -0.5, 3],
projection="M5c",
frame="a",
textfiles=tempfile.name,
angle=True,
font=True,
justify=True,
)
return fig