acpt: add Document.start_bookmark() scenario

scanny · scanny · commit a6fde18e224a · 2021-05-15T15:32:43.000-07:00
diff --git a/features/doc-document.feature b/features/doc-document.feature
@@ -0,0 +1,11 @@
+Feature: Document properties and methods
+  In order manipulate a Word document
+  As a developer using python-docx
+  I need properties and methods on the Document object
+
+  @wip
+  Scenario: Document.start_bookmark()
+    Given a Document object as document
+     When I assign bookmark = document.start_bookmark("Target")
+     Then bookmark.name == "Target"
+      And bookmark.id is an int
diff --git a/features/steps/bookmarks.py b/features/steps/bookmarks.py
@@ -23,6 +23,18 @@ def given_a_Bookmarks_object_of_length_5_as_bookmarks(context):
 # then =====================================================
 
 
+@then("bookmark.id is an int")
+def then_bookmark_id_is_an_int(context):
+    bookmark = context.bookmark
+    assert isinstance(bookmark.id, int)
+
+
+@then('bookmark.name == "Target"')
+def then_bookmark_name_eq_Target(context):
+    bookmark = context.bookmark
+    assert bookmark.name == "Target"
+
+
 @then('bookmarks.get({name}) returns bookmark named "{name}" with id {id}')
 def then_bookmark_get_returns_bookmark_object(context, name, id):
     bookmark = context.bookmarks.get(name)
diff --git a/features/steps/document.py b/features/steps/document.py
@@ -22,44 +22,45 @@
 
 # given ===================================================
 
-@given('a blank document')
+
+@given("a blank document")
 def given_a_blank_document(context):
-    context.document = Document(test_docx('doc-word-default-blank'))
+    context.document = Document(test_docx("doc-word-default-blank"))
 
 
-@given('a Document object as document')
+@given("a Document object as document")
 def given_a_Document_object_as_document(context):
-    context.document = Document(test_docx('doc-default'))
+    context.document = Document(test_docx("doc-default"))
 
 
-@given('a document having built-in styles')
+@given("a document having built-in styles")
 def given_a_document_having_builtin_styles(context):
     context.document = Document()
 
 
-@given('a document having inline shapes')
+@given("a document having inline shapes")
 def given_a_document_having_inline_shapes(context):
-    context.document = Document(test_docx('shp-inline-shape-access'))
+    context.document = Document(test_docx("shp-inline-shape-access"))
 
 
-@given('a document having sections')
+@given("a document having sections")
 def given_a_document_having_sections(context):
-    context.document = Document(test_docx('doc-access-sections'))
+    context.document = Document(test_docx("doc-access-sections"))
 
 
-@given('a document having styles')
+@given("a document having styles")
 def given_a_document_having_styles(context):
-    context.document = Document(test_docx('sty-having-styles-part'))
+    context.document = Document(test_docx("sty-having-styles-part"))
 
 
-@given('a document having three tables')
+@given("a document having three tables")
 def given_a_document_having_three_tables(context):
-    context.document = Document(test_docx('tbl-having-tables'))
+    context.document = Document(test_docx("tbl-having-tables"))
 
 
-@given('a single-section document having portrait layout')
+@given("a single-section document having portrait layout")
 def given_a_single_section_document_having_portrait_layout(context):
-    context.document = Document(test_docx('doc-add-section'))
+    context.document = Document(test_docx("doc-add-section"))
     section = context.document.sections[-1]
     context.original_dimensions = (section.page_width, section.page_height)
 
@@ -71,55 +72,53 @@ def given_a_single_section_Document_object_with_headers_and_footers(context):
 
 # when ====================================================
 
-@when('I add a 2 x 2 table specifying only row and column count')
+
+@when("I add a 2 x 2 table specifying only row and column count")
 def when_add_2x2_table_specifying_only_row_and_col_count(context):
     document = context.document
     document.add_table(rows=2, cols=2)
 
 
-@when('I add a 2 x 2 table specifying style \'{style_name}\'')
+@when("I add a 2 x 2 table specifying style '{style_name}'")
 def when_add_2x2_table_specifying_style_name(context, style_name):
     document = context.document
     document.add_table(rows=2, cols=2, style=style_name)
 
 
-@when('I add a heading specifying level={level}')
+@when("I add a heading specifying level={level}")
 def when_add_heading_specifying_level(context, level):
     context.document.add_heading(level=int(level))
 
 
-@when('I add a heading specifying only its text')
+@when("I add a heading specifying only its text")
 def when_add_heading_specifying_only_its_text(context):
     document = context.document
-    context.heading_text = text = 'Spam vs. Eggs'
+    context.heading_text = text = "Spam vs. Eggs"
     document.add_heading(text)
 
 
-@when('I add a page break to the document')
+@when("I add a page break to the document")
 def when_add_page_break_to_document(context):
     document = context.document
     document.add_page_break()
 
 
-@when('I add a paragraph specifying its style as a {kind}')
+@when("I add a paragraph specifying its style as a {kind}")
 def when_I_add_a_paragraph_specifying_its_style_as_a(context, kind):
     document = context.document
-    style = context.style = document.styles['Heading 1']
-    style_spec = {
-        'style object': style,
-        'style name':   'Heading 1',
-    }[kind]
+    style = context.style = document.styles["Heading 1"]
+    style_spec = {"style object": style, "style name": "Heading 1"}[kind]
     document.add_paragraph(style=style_spec)
 
 
-@when('I add a paragraph specifying its text')
+@when("I add a paragraph specifying its text")
 def when_add_paragraph_specifying_text(context):
     document = context.document
-    context.paragraph_text = 'foobar'
+    context.paragraph_text = "foobar"
     document.add_paragraph(context.paragraph_text)
 
 
-@when('I add a paragraph without specifying text or style')
+@when("I add a paragraph without specifying text or style")
 def when_add_paragraph_without_specifying_text_or_style(context):
     document = context.document
     document.add_paragraph()
@@ -129,39 +128,44 @@ def when_add_paragraph_without_specifying_text_or_style(context):
 def when_add_picture_specifying_width_and_height(context):
     document = context.document
     context.picture = document.add_picture(
-        test_file('monty-truth.png'),
-        width=Inches(1.75), height=Inches(2.5)
+        test_file("monty-truth.png"), width=Inches(1.75), height=Inches(2.5)
     )
 
 
-@when('I add a picture specifying a height of 1.5 inches')
+@when("I add a picture specifying a height of 1.5 inches")
 def when_add_picture_specifying_height(context):
     document = context.document
     context.picture = document.add_picture(
-        test_file('monty-truth.png'), height=Inches(1.5)
+        test_file("monty-truth.png"), height=Inches(1.5)
     )
 
 
-@when('I add a picture specifying a width of 1.5 inches')
+@when("I add a picture specifying a width of 1.5 inches")
 def when_add_picture_specifying_width(context):
     document = context.document
     context.picture = document.add_picture(
-        test_file('monty-truth.png'), width=Inches(1.5)
+        test_file("monty-truth.png"), width=Inches(1.5)
     )
 
 
-@when('I add a picture specifying only the image file')
+@when("I add a picture specifying only the image file")
 def when_add_picture_specifying_only_image_file(context):
     document = context.document
-    context.picture = document.add_picture(test_file('monty-truth.png'))
+    context.picture = document.add_picture(test_file("monty-truth.png"))
 
 
-@when('I add an even-page section to the document')
+@when("I add an even-page section to the document")
 def when_I_add_an_even_page_section_to_the_document(context):
     context.section = context.document.add_section(WD_SECTION.EVEN_PAGE)
 
 
-@when('I change the new section layout to landscape')
+@when('I assign bookmark = document.start_bookmark("Target")')
+def when_I_assign_bookmark_eq_document_start_bookmark(context):
+    document = context.document
+    context.bookmark = document.start_bookmark("Target")
+
+
+@when("I change the new section layout to landscape")
 def when_I_change_the_new_section_layout_to_landscape(context):
     new_height, new_width = context.original_dimensions
     section = context.section
@@ -177,21 +181,22 @@ def when_I_execute_section_eq_document_add_section(context):
 
 # then ====================================================
 
-@then('document.bookmarks is a Bookmarks object')
+
+@then("document.bookmarks is a Bookmarks object")
 def then_document_bookmarks_is_a_Bookmarks_object(context):
     actual = context.document.bookmarks.__class__.__name__
-    expected = 'Bookmarks'
-    assert actual == expected, 'document.bookmarks is a %s object' % actual
+    expected = "Bookmarks"
+    assert actual == expected, "document.bookmarks is a %s object" % actual
 
 
-@then('document.inline_shapes is an InlineShapes object')
+@then("document.inline_shapes is an InlineShapes object")
 def then_document_inline_shapes_is_an_InlineShapes_object(context):
     document = context.document
     inline_shapes = document.inline_shapes
     assert isinstance(inline_shapes, InlineShapes)
 
 
-@then('document.paragraphs is a list containing three paragraphs')
+@then("document.paragraphs is a list containing three paragraphs")
 def then_document_paragraphs_is_a_list_containing_three_paragraphs(context):
     document = context.document
     paragraphs = document.paragraphs
@@ -201,20 +206,20 @@ def then_document_paragraphs_is_a_list_containing_three_paragraphs(context):
         assert isinstance(paragraph, Paragraph)
 
 
-@then('document.sections is a Sections object')
+@then("document.sections is a Sections object")
 def then_document_sections_is_a_Sections_object(context):
     sections = context.document.sections
-    msg = 'document.sections not instance of Sections'
+    msg = "document.sections not instance of Sections"
     assert isinstance(sections, Sections), msg
 
 
-@then('document.styles is a Styles object')
+@then("document.styles is a Styles object")
 def then_document_styles_is_a_Styles_object(context):
     styles = context.document.styles
     assert isinstance(styles, Styles)
 
 
-@then('document.tables is a list containing three tables')
+@then("document.tables is a list containing three tables")
 def then_document_tables_is_a_list_containing_three_tables(context):
     document = context.document
     tables = document.tables
@@ -224,7 +229,7 @@ def then_document_tables_is_a_list_containing_three_tables(context):
         assert isinstance(table, Table)
 
 
-@then('the document contains a 2 x 2 table')
+@then("the document contains a 2 x 2 table")
 def then_the_document_contains_a_2x2_table(context):
     table = context.document.tables[-1]
     assert isinstance(table, Table)
@@ -233,12 +238,12 @@ def then_the_document_contains_a_2x2_table(context):
     context.table_ = table
 
 
-@then('the document has two sections')
+@then("the document has two sections")
 def then_the_document_has_two_sections(context):
     assert len(context.document.sections) == 2
 
 
-@then('the first section is portrait')
+@then("the first section is portrait")
 def then_the_first_section_is_portrait(context):
     first_section = context.document.sections[0]
     expected_width, expected_height = context.original_dimensions
@@ -247,24 +252,24 @@ def then_the_first_section_is_portrait(context):
     assert first_section.page_height == expected_height
 
 
-@then('the last paragraph contains only a page break')
+@then("the last paragraph contains only a page break")
 def then_last_paragraph_contains_only_a_page_break(context):
     document = context.document
     paragraph = document.paragraphs[-1]
     assert len(paragraph.runs) == 1
     assert len(paragraph.runs[0]._r) == 1
-    assert paragraph.runs[0]._r[0].type == 'page'
+    assert paragraph.runs[0]._r[0].type == "page"
 
 
-@then('the last paragraph contains the heading text')
+@then("the last paragraph contains the heading text")
 def then_last_p_contains_heading_text(context):
     document = context.document
     text = context.heading_text
     paragraph = document.paragraphs[-1]
     assert paragraph.text == text
 
 
-@then('the second section is landscape')
+@then("the second section is landscape")
 def then_the_second_section_is_landscape(context):
     new_section = context.document.sections[-1]
     expected_height, expected_width = context.original_dimensions
@@ -273,10 +278,8 @@ def then_the_second_section_is_landscape(context):
     assert new_section.page_height == expected_height
 
 
-@then('the style of the last paragraph is \'{style_name}\'')
+@then("the style of the last paragraph is '{style_name}'")
 def then_the_style_of_the_last_paragraph_is_style(context, style_name):
     document = context.document
     paragraph = document.paragraphs[-1]
-    assert paragraph.style.name == style_name, (
-        'got %s' % paragraph.style.name
-    )
+    assert paragraph.style.name == style_name, "got %s" % paragraph.style.name
