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 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
|
"""Step implementations for styles-related features."""
from behave import given, then, when
from docx import Document
from docx.enum.style import WD_STYLE_TYPE
from docx.styles.latent import LatentStyles, _LatentStyle
from docx.styles.style import BaseStyle
from docx.text.font import Font
from docx.text.parfmt import ParagraphFormat
from helpers import bool_vals, test_docx, tri_state_vals
style_types = {
"WD_STYLE_TYPE.CHARACTER": WD_STYLE_TYPE.CHARACTER,
"WD_STYLE_TYPE.PARAGRAPH": WD_STYLE_TYPE.PARAGRAPH,
"WD_STYLE_TYPE.LIST": WD_STYLE_TYPE.LIST,
"WD_STYLE_TYPE.TABLE": WD_STYLE_TYPE.TABLE,
}
# given ===================================================
@given("a document having a styles part")
def given_a_document_having_a_styles_part(context):
docx_path = test_docx("sty-having-styles-part")
context.document = Document(docx_path)
@given("a document having known styles")
def given_a_document_having_known_styles(context):
docx_path = test_docx("sty-known-styles")
document = Document(docx_path)
context.document = document
context.style_count = len(document.styles)
@given("a document having no styles part")
def given_a_document_having_no_styles_part(context):
docx_path = test_docx("sty-having-no-styles-part")
context.document = Document(docx_path)
@given("a latent style collection")
def given_a_latent_style_collection(context):
document = Document(test_docx("sty-known-styles"))
context.latent_styles = document.styles.latent_styles
@given("a latent style having a known name")
def given_a_latent_style_having_a_known_name(context):
document = Document(test_docx("sty-known-styles"))
latent_styles = list(document.styles.latent_styles)
context.latent_style = latent_styles[0] # should be 'Normal'
@given("a latent style having priority of {setting}")
def given_a_latent_style_having_priority_of_setting(context, setting):
latent_style_name = {
"42": "Normal",
"no setting": "Subtitle",
}[setting]
document = Document(test_docx("sty-known-styles"))
latent_styles = document.styles.latent_styles
context.latent_style = latent_styles[latent_style_name]
@given("a latent style having {prop_name} set {setting}")
def given_a_latent_style_having_prop_setting(context, prop_name, setting):
latent_style_name = {
"on": "Normal",
"off": "Title",
"no setting": "Subtitle",
}[setting]
document = Document(test_docx("sty-known-styles"))
latent_styles = document.styles.latent_styles
context.latent_style = latent_styles[latent_style_name]
@given("a latent styles object with known defaults")
def given_a_latent_styles_object_with_known_defaults(context):
document = Document(test_docx("sty-known-styles"))
context.latent_styles = document.styles.latent_styles
@given("a style based on {base_style}")
def given_a_style_based_on_setting(context, base_style):
style_name = {
"no style": "Base",
"Normal": "Sub Normal",
"Base": "Citation",
}[base_style]
document = Document(test_docx("sty-known-styles"))
context.styles = document.styles
context.style = document.styles[style_name]
@given("a style having a known {attr_name}")
def given_a_style_having_a_known_attr_name(context, attr_name):
docx_path = test_docx("sty-having-styles-part")
document = Document(docx_path)
context.style = document.styles["Normal"]
@given("a style having hidden set {setting}")
def given_a_style_having_hidden_set_setting(context, setting):
document = Document(test_docx("sty-behav-props"))
style_name = {
"on": "Foo",
"off": "Bar",
"no setting": "Baz",
}[setting]
context.style = document.styles[style_name]
@given("a style having locked set {setting}")
def given_a_style_having_locked_setting(context, setting):
document = Document(test_docx("sty-behav-props"))
style_name = {
"on": "Foo",
"off": "Bar",
"no setting": "Baz",
}[setting]
context.style = document.styles[style_name]
@given("a style having next paragraph style set to {setting}")
def given_a_style_having_next_paragraph_style_setting(context, setting):
document = Document(test_docx("sty-known-styles"))
style_name = {
"Sub Normal": "Citation",
"Foobar": "Sub Normal",
"Base": "Foo",
"no setting": "Base",
}[setting]
context.styles = document.styles
context.style = document.styles[style_name]
@given("a style having priority of {setting}")
def given_a_style_having_priority_of_setting(context, setting):
document = Document(test_docx("sty-behav-props"))
style_name = {
"no setting": "Baz",
"42": "Foo",
}[setting]
context.style = document.styles[style_name]
@given("a style having quick-style set {setting}")
def given_a_style_having_quick_style_setting(context, setting):
document = Document(test_docx("sty-behav-props"))
style_name = {
"on": "Foo",
"off": "Bar",
"no setting": "Baz",
}[setting]
context.style = document.styles[style_name]
@given("a style having unhide-when-used set {setting}")
def given_a_style_having_unhide_when_used_setting(context, setting):
document = Document(test_docx("sty-behav-props"))
style_name = {
"on": "Foo",
"off": "Bar",
"no setting": "Baz",
}[setting]
context.style = document.styles[style_name]
@given("a style of type {style_type}")
def given_a_style_of_type(context, style_type):
document = Document(test_docx("sty-known-styles"))
name = {
"WD_STYLE_TYPE.CHARACTER": "Default Paragraph Font",
"WD_STYLE_TYPE.LIST": "No List",
"WD_STYLE_TYPE.PARAGRAPH": "Normal",
"WD_STYLE_TYPE.TABLE": "Normal Table",
}[style_type]
context.style = document.styles[name]
@given("the style collection of a document")
def given_the_style_collection_of_a_document(context):
document = Document(test_docx("sty-known-styles"))
context.styles = document.styles
# when =====================================================
@when("I add a latent style named 'Foobar'")
def when_I_add_a_latent_style_named_Foobar(context):
latent_styles = context.document.styles.latent_styles
context.latent_styles = latent_styles
context.latent_style_count = len(latent_styles)
latent_styles.add_latent_style("Foobar")
@when("I assign a new name to the style")
def when_I_assign_a_new_name_to_the_style(context):
context.style.name = "Foobar"
@when("I assign a new value to style.style_id")
def when_I_assign_a_new_value_to_style_style_id(context):
context.style.style_id = "Foo42"
@when("I assign {value} to latent_style.{prop_name}")
def when_I_assign_value_to_latent_style_prop(context, value, prop_name):
latent_style = context.latent_style
new_value = tri_state_vals[value] if value in tri_state_vals else int(value)
setattr(latent_style, prop_name, new_value)
@when("I assign {value} to latent_styles.{prop_name}")
def when_I_assign_value_to_latent_styles_prop(context, value, prop_name):
latent_styles = context.latent_styles
new_value = bool_vals[value] if value in bool_vals else int(value)
setattr(latent_styles, prop_name, new_value)
@when("I assign {value_key} to style.base_style")
def when_I_assign_value_to_style_base_style(context, value_key):
value = {
"None": None,
"styles['Normal']": context.styles["Normal"],
"styles['Base']": context.styles["Base"],
}[value_key]
context.style.base_style = value
@when("I assign {value} to style.hidden")
def when_I_assign_value_to_style_hidden(context, value):
style, new_value = context.style, tri_state_vals[value]
style.hidden = new_value
@when("I assign {value} to style.locked")
def when_I_assign_value_to_style_locked(context, value):
style, new_value = context.style, bool_vals[value]
style.locked = new_value
@when("I assign {value} to style.next_paragraph_style")
def when_I_assign_value_to_style_next_paragraph_style(context, value):
styles, style = context.styles, context.style
new_value = None if value == "None" else styles[value]
style.next_paragraph_style = new_value
@when("I assign {value} to style.priority")
def when_I_assign_value_to_style_priority(context, value):
style = context.style
new_value = None if value == "None" else int(value)
style.priority = new_value
@when("I assign {value} to style.quick_style")
def when_I_assign_value_to_style_quick_style(context, value):
style, new_value = context.style, bool_vals[value]
style.quick_style = new_value
@when("I assign {value} to style.unhide_when_used")
def when_I_assign_value_to_style_unhide_when_used(context, value):
style, new_value = context.style, bool_vals[value]
style.unhide_when_used = new_value
@when("I call add_style('{name}', {type_str}, builtin={builtin_str})")
def when_I_call_add_style(context, name, type_str, builtin_str):
styles = context.document.styles
type = style_types[type_str]
builtin = bool_vals[builtin_str]
styles.add_style(name, type, builtin=builtin)
@when("I delete a latent style")
def when_I_delete_a_latent_style(context):
latent_styles = context.document.styles.latent_styles
context.latent_styles = latent_styles
context.latent_style_count = len(latent_styles)
latent_styles["Normal"].delete()
@when("I delete a style")
def when_I_delete_a_style(context):
context.document.styles["No List"].delete()
# then =====================================================
@then("I can access a latent style by name")
def then_I_can_access_a_latent_style_by_name(context):
latent_styles = context.latent_styles
latent_style = latent_styles["Colorful Shading"]
assert isinstance(latent_style, _LatentStyle)
@then("I can access a style by its UI name")
def then_I_can_access_a_style_by_its_UI_name(context):
styles = context.document.styles
style = styles["Default Paragraph Font"]
assert isinstance(style, BaseStyle)
@then("I can access a style by style id")
def then_I_can_access_a_style_by_style_id(context):
styles = context.document.styles
style = styles["DefaultParagraphFont"]
assert isinstance(style, BaseStyle)
@then("I can iterate over its styles")
def then_I_can_iterate_over_its_styles(context):
styles = list(context.document.styles)
assert len(styles) > 0
assert all(isinstance(s, BaseStyle) for s in styles)
@then("I can iterate over the latent styles")
def then_I_can_iterate_over_the_latent_styles(context):
latent_styles = list(context.latent_styles)
assert len(latent_styles) == 137
assert all(isinstance(ls, _LatentStyle) for ls in latent_styles)
@then("latent_style.name is the known name")
def then_latent_style_name_is_the_known_name(context):
latent_style = context.latent_style
assert latent_style.name == "Normal"
@then("latent_style.priority is {value}")
def then_latent_style_priority_is_value(context, value):
latent_style = context.latent_style
expected_value = None if value == "None" else int(value)
assert latent_style.priority == expected_value
@then("latent_style.{prop_name} is {value}")
def then_latent_style_prop_name_is_value(context, prop_name, value):
latent_style = context.latent_style
actual_value = getattr(latent_style, prop_name)
expected_value = tri_state_vals[value]
assert actual_value == expected_value
@then("latent_styles['Foobar'] is a latent style")
def then_latentStyles_Foobar_is_a_latent_style(context):
latent_styles = context.latent_styles
latent_style = latent_styles["Foobar"]
assert isinstance(latent_style, _LatentStyle)
@then("latent_styles.{prop_name} is {value}")
def then_latent_styles_prop_name_is_value(context, prop_name, value):
latent_styles = context.latent_styles
expected_value = bool_vals[value] if value in bool_vals else int(value)
actual_value = getattr(latent_styles, prop_name)
assert actual_value == expected_value
@then("len(latent_styles) is 137")
def then_len_latent_styles_is_137(context):
assert len(context.latent_styles) == 137
@then("len(styles) is {style_count_str}")
def then_len_styles_is_style_count(context, style_count_str):
assert len(context.document.styles) == int(style_count_str)
@then("style.base_style is {value_key}")
def then_style_base_style_is_value(context, value_key):
expected_value = {
"None": None,
"styles['Normal']": context.styles["Normal"],
"styles['Base']": context.styles["Base"],
}[value_key]
style = context.style
assert style.base_style == expected_value
@then("style.builtin is {builtin_str}")
def then_style_builtin_is_builtin(context, builtin_str):
style = context.style
builtin = bool_vals[builtin_str]
assert style.builtin == builtin
@then("style.font is the Font object for the style")
def then_style_font_is_the_Font_object_for_the_style(context):
style = context.style
font = style.font
assert isinstance(font, Font)
assert font.element is style.element
@then("style.hidden is {value}")
def then_style_hidden_is_value(context, value):
style, expected_value = context.style, tri_state_vals[value]
assert style.hidden is expected_value
@then("style.locked is {value}")
def then_style_locked_is_value(context, value):
style, expected_value = context.style, bool_vals[value]
assert style.locked is expected_value
@then("style.name is the {which} name")
def then_style_name_is_the_which_name(context, which):
expected_name = {
"known": "Normal",
"new": "Foobar",
}[which]
style = context.style
assert style.name == expected_name
@then("style.next_paragraph_style is {value}")
def then_style_next_paragraph_style_is_value(context, value):
style, styles = context.style, context.styles
actual_value = style.next_paragraph_style
expected_value = styles[value]
assert actual_value == expected_value, "got %s" % actual_value
@then("style.paragraph_format is the ParagraphFormat object for the style")
def then_style_paragraph_format_is_the_ParagraphFormat_object(context):
style = context.style
paragraph_format = style.paragraph_format
assert isinstance(paragraph_format, ParagraphFormat)
assert paragraph_format.element is style.element
@then("style.priority is {value}")
def then_style_priority_is_value(context, value):
style = context.style
expected_value = None if value == "None" else int(value)
assert style.priority == expected_value
@then("style.quick_style is {value}")
def then_style_quick_style_is_value(context, value):
style, expected_value = context.style, bool_vals[value]
assert style.quick_style is expected_value
@then("style.style_id is the {which} style id")
def then_style_style_id_is_the_which_style_id(context, which):
expected_style_id = {
"known": "Normal",
"new": "Foo42",
}[which]
style = context.style
assert style.style_id == expected_style_id
@then("style.type is the known type")
def then_style_type_is_the_known_type(context):
style = context.style
assert style.type == WD_STYLE_TYPE.PARAGRAPH
@then("style.type is {type_str}")
def then_style_type_is_type(context, type_str):
style = context.style
style_type = style_types[type_str]
assert style.type == style_type
@then("style.unhide_when_used is {value}")
def then_style_unhide_when_used_is_value(context, value):
style, expected_value = context.style, bool_vals[value]
assert style.unhide_when_used is expected_value
@then("styles.latent_styles is the LatentStyles object for the document")
def then_styles_latent_styles_is_the_LatentStyles_object(context):
styles = context.styles
context.latent_styles = latent_styles = styles.latent_styles
assert isinstance(latent_styles, LatentStyles)
assert latent_styles.element is styles.element.latentStyles
@then("styles['{name}'] is a style")
def then_styles_name_is_a_style(context, name):
styles = context.document.styles
style = context.style = styles[name]
assert isinstance(style, BaseStyle)
@then("the deleted latent style is not in the latent styles collection")
def then_the_deleted_latent_style_is_not_in_the_collection(context):
latent_styles = context.latent_styles
try:
latent_styles["Normal"]
except KeyError:
return
raise AssertionError("Latent style not deleted")
@then("the deleted style is not in the styles collection")
def then_the_deleted_style_is_not_in_the_styles_collection(context):
document = context.document
try:
document.styles["No List"]
except KeyError:
return
raise AssertionError("Style not deleted")
@then("the document has one additional latent style")
def then_the_document_has_one_additional_latent_style(context):
latent_styles = context.document.styles.latent_styles
latent_style_count = len(latent_styles)
expected_count = context.latent_style_count + 1
assert latent_style_count == expected_count
@then("the document has one additional style")
def then_the_document_has_one_additional_style(context):
document = context.document
style_count = len(document.styles)
expected_style_count = context.style_count + 1
assert style_count == expected_style_count
@then("the document has one fewer latent styles")
def then_the_document_has_one_fewer_latent_styles(context):
latent_style_count = len(context.latent_styles)
expected_count = context.latent_style_count - 1
assert latent_style_count == expected_count
@then("the document has one fewer styles")
def then_the_document_has_one_fewer_styles(context):
document = context.document
style_count = len(document.styles)
expected_style_count = context.style_count - 1
assert style_count == expected_style_count
|