xfail: acceptance test for Comment properties

scanny · scanny · commit 7cf36d648fb1 · 2025-06-16T14:24:39.000-07:00
diff --git a/features/cmt-props.feature b/features/cmt-props.feature
@@ -0,0 +1,40 @@
+Feature: Get comment properties
+  In order to characterize comments by their metadata
+  As a developer using python-docx
+  I need methods to access comment metadata properties
+
+
+  Scenario: Comment.id
+    Given a Comment object
+     Then comment.comment_id is the comment identifier
+
+
+  @wip
+  Scenario: Comment.author
+    Given a Comment object
+     Then comment.author is the author of the comment
+
+
+  @wip
+  Scenario: Comment.initials
+    Given a Comment object
+     Then comment.initials is the initials of the comment author
+
+
+  @wip
+  Scenario: Comment.timestamp
+    Given a Comment object
+     Then comment.timestamp is the date and time the comment was authored
+
+
+  @wip
+  Scenario: Comment.paragraphs[0].text
+    Given a Comment object
+     When I assign para_text = comment.paragraphs[0].text
+     Then para_text is the text of the first paragraph in the comment
+
+
+  @wip
+  Scenario: Retrieve embedded image from a comment
+    Given a Comment object containing an embedded image
+     Then I can extract the image from the comment
diff --git a/features/steps/comments.py b/features/steps/comments.py
@@ -1,16 +1,29 @@
 """Step implementations for document comments-related features."""
 
+import datetime as dt
+
 from behave import given, then, when
 from behave.runner import Context
 
 from docx import Document
 from docx.comments import Comment, Comments
+from docx.drawing import Drawing
 
 from helpers import test_docx
 
 # given ====================================================
 
 
+@given("a Comment object")
+def given_a_comment_object(context: Context):
+    context.comment = Document(test_docx("comments-rich-para")).comments.get(0)
+
+
+@given("a Comment object containing an embedded image")
+def given_a_comment_object_containing_an_embedded_image(context: Context):
+    context.comment = Document(test_docx("comments-rich-para")).comments.get(1)
+
+
 @given("a Comments object with {count} comments")
 def given_a_comments_object_with_count_comments(context: Context, count: str):
     testfile_name = {"0": "doc-default", "4": "comments-rich-para"}[count]
@@ -30,6 +43,11 @@ def given_a_document_having_no_comments_part(context: Context):
 # when =====================================================
 
 
+@when("I assign para_text = comment.paragraphs[0].text")
+def when_I_assign_para_text(context: Context):
+    context.para_text = context.comment.paragraphs[0].text
+
+
 @when("I call comments.get(2)")
 def when_I_call_comments_get_2(context: Context):
     context.comment = context.comments.get(2)
@@ -38,12 +56,48 @@ def when_I_call_comments_get_2(context: Context):
 # then =====================================================
 
 
+@then("comment.author is the author of the comment")
+def then_comment_author_is_the_author_of_the_comment(context: Context):
+    actual = context.comment.author
+    assert actual == "Steve Canny", f"expected author 'Steve Canny', got '{actual}'"
+
+
+@then("comment.comment_id is the comment identifier")
+def then_comment_comment_id_is_the_comment_identifier(context: Context):
+    assert context.comment.comment_id == 0
+
+
+@then("comment.initials is the initials of the comment author")
+def then_comment_initials_is_the_initials_of_the_comment_author(context: Context):
+    initials = context.comment.initials
+    assert initials == "SJC", f"expected initials 'SJC', got '{initials}'"
+
+
+@then("comment.timestamp is the date and time the comment was authored")
+def then_comment_timestamp_is_the_date_and_time_the_comment_was_authored(context: Context):
+    assert context.comment.timestamp == dt.datetime(2025, 6, 7, 11, 20, 0, tzinfo=dt.timezone.utc)
+
+
 @then("document.comments is a Comments object")
 def then_document_comments_is_a_Comments_object(context: Context):
     document = context.document
     assert type(document.comments) is Comments
 
 
+@then("I can extract the image from the comment")
+def then_I_can_extract_the_image_from_the_comment(context: Context):
+    paragraph = context.comment.paragraphs[0]
+    run = paragraph.runs[2]
+    drawing = next(d for d in run.iter_inner_content() if isinstance(d, Drawing))
+    assert drawing.has_picture
+
+    image = drawing.image
+
+    assert image.content_type == "image/jpeg", f"got {image.content_type}"
+    assert image.filename == "image.jpg", f"got {image.filename}"
+    assert image.sha1 == "1be010ea47803b00e140b852765cdf84f491da47", f"got {image.sha1}"
+
+
 @then("iterating comments yields {count} Comment objects")
 def then_iterating_comments_yields_count_comments(context: Context, count: str):
     comment_iter = iter(context.comments)
@@ -62,6 +116,13 @@ def then_len_comments_eq_count(context: Context, count: str):
     assert actual == expected, f"expected len(comments) of {expected}, got {actual}"
 
 
+@then("para_text is the text of the first paragraph in the comment")
+def then_para_text_is_the_text_of_the_first_paragraph_in_the_comment(context: Context):
+    actual = context.para_text
+    expected = "Text with hyperlink https://google.com embedded."
+    assert actual == expected, f"expected para_text '{expected}', got '{actual}'"
+
+
 @then("the result is a Comment object with id 2")
 def then_the_result_is_a_comment_object_with_id_2(context: Context):
     comment = context.comment
