comments: add Comment.author

Author: scanny

features/cmt-props.feature

@@ -9,7 +9,6 @@ Feature: Get comment properties
      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

src/docx/comments.py

@@ -53,6 +53,11 @@ def __init__(self, comment_elm: CT_Comment, comments_part: CommentsPart):
         super().__init__(comment_elm, comments_part)
         self._comment_elm = comment_elm
 
+    @property
+    def author(self) -> str:
+        """The recorded author of this comment."""
+        return self._comment_elm.author
+
     @property
     def comment_id(self) -> int:
         """The unique identifier of this comment."""

src/docx/oxml/comments.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from docx.oxml.simpletypes import ST_DecimalNumber
+from docx.oxml.simpletypes import ST_DecimalNumber, ST_String
 from docx.oxml.xmlchemy import BaseOxmlElement, RequiredAttribute, ZeroOrMore
 
 
@@ -35,3 +35,4 @@ class CT_Comment(BaseOxmlElement):
     """
 
     id: int = RequiredAttribute("w:id", ST_DecimalNumber)  # pyright: ignore[reportAssignmentType]
+    author: str = RequiredAttribute("w:author", ST_String)  # pyright: ignore[reportAssignmentType]

tests/test_comments.py

@@ -101,6 +101,12 @@ def it_knows_its_comment_id(self, comments_part_: Mock):
 
         assert comment.comment_id == 42
 
+    def it_knows_its_author(self, comments_part_: Mock):
+        comment_elm = cast(CT_Comment, element("w:comment{w:id=42,w:author=Steve Canny}"))
+        comment = Comment(comment_elm, comments_part_)
+
+        assert comment.author == "Steve Canny"
+
     # -- fixtures --------------------------------------------------------------------------------
 
     @pytest.fixture