instance_id stringlengths 37 155 | project stringclasses 8
values | language stringclasses 5
values | framework stringclasses 4
values | repo_url stringclasses 8
values | base_commit stringclasses 8
values | feature_repo_url stringclasses 8
values | feature_commit stringclasses 8
values | feature dict | scenario dict | requirement_richness stringclasses 3
values | target_interfaces listlengths 0 72 | target_interfaces_empty_reason stringclasses 1
value | test_level stringclasses 3
values | test_level_class stringclasses 23
values | in_eval_split bool 1
class | gt_test_files listlengths 1 25 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
python-docx/features/blk-iter-inner-content.feature:12 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/blk-iter-inner-content.feature",
"title": "Iterate paragraphs and tables in document-order",
"narrative": " In order to access paragraphs and tables in the same order they appear in the document\n As a developer using python-docx\n I need the ability to iterate the inner-content of a b... | {
"title": "Header.iter_inner_content()",
"line": 12,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Header.iter_inner_content()\n Given a Header object with paragraphs and tables\n Then header.iter_inner_content() produces the block-items in document order"
} | user_story | [
{
"declaration": "def iter_inner_content(self) -> Iterator[Paragraph | Table]:",
"key": [
"docx.blkcntnr.BlockItemContainer",
"iter_inner_content"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/block.py",
"features/steps/helpers.py"
] |
python-docx/features/blk-iter-inner-content.feature:17 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/blk-iter-inner-content.feature",
"title": "Iterate paragraphs and tables in document-order",
"narrative": " In order to access paragraphs and tables in the same order they appear in the document\n As a developer using python-docx\n I need the ability to iterate the inner-content of a b... | {
"title": "Footer.iter_inner_content()",
"line": 17,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Footer.iter_inner_content()\n Given a Footer object with paragraphs and tables\n Then footer.iter_inner_content() produces the block-items in document order"
} | user_story | [
{
"declaration": "def iter_inner_content(self) -> Iterator[Paragraph | Table]:",
"key": [
"docx.blkcntnr.BlockItemContainer",
"iter_inner_content"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/block.py",
"features/steps/helpers.py"
] |
python-docx/features/blk-iter-inner-content.feature:22 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/blk-iter-inner-content.feature",
"title": "Iterate paragraphs and tables in document-order",
"narrative": " In order to access paragraphs and tables in the same order they appear in the document\n As a developer using python-docx\n I need the ability to iterate the inner-content of a b... | {
"title": "_Cell.iter_inner_content()",
"line": 22,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: _Cell.iter_inner_content()\n Given a _Cell object with paragraphs and tables\n Then cell.iter_inner_content() produces the block-items in document order"
} | user_story | [
{
"declaration": "def iter_inner_content(self) -> Iterator[Paragraph | Table]:",
"key": [
"docx.blkcntnr.BlockItemContainer",
"iter_inner_content"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/block.py",
"features/steps/helpers.py"
] |
python-docx/features/blk-iter-inner-content.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/blk-iter-inner-content.feature",
"title": "Iterate paragraphs and tables in document-order",
"narrative": " In order to access paragraphs and tables in the same order they appear in the document\n As a developer using python-docx\n I need the ability to iterate the inner-content of a b... | {
"title": "Document.iter_inner_content()",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Document.iter_inner_content()\n Given a Document object with paragraphs and tables\n Then document.iter_inner_content() produces the block-items in document order"
} | user_story | [
{
"declaration": "def iter_inner_content(self) -> Iterator[Paragraph | Table]:",
"key": [
"docx.blkcntnr.BlockItemContainer",
"iter_inner_content"
]
},
{
"declaration": "def iter_inner_content(self) -> Iterator[Paragraph | Table]:",
"key": [
"docx.document.Document",
... | null | system | PY-FACADE | true | [
"features/steps/block.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-mutations.feature:17 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-mutations.feature",
"title": "Comment mutations",
"narrative": " In order to add and modify the content of a comment\n As a developer using python-docx\n I need mutation methods on Comment objects",
"background": null
} | {
"title": "Comments.add_comment() specifying author and initials",
"line": 17,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comments.add_comment() specifying author and initials\n Given a Comments object with 0 comments\n When I assign comment = comments.add_comment(author=\"John Doe\", ini... | user_story | [
{
"declaration": "(property getter) def author(self) -> str:",
"key": [
"docx.comments.Comment",
"author"
]
},
{
"declaration": "(property getter) def initials(self) -> str | None:",
"key": [
"docx.comments.Comment",
"initials"
]
},
{
"declaration": "def a... | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-mutations.feature:24 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-mutations.feature",
"title": "Comment mutations",
"narrative": " In order to add and modify the content of a comment\n As a developer using python-docx\n I need mutation methods on Comment objects",
"background": null
} | {
"title": "Comment.add_paragraph() specifying text and style",
"line": 24,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comment.add_paragraph() specifying text and style\n Given a default Comment object\n When I assign paragraph = comment.add_paragraph(text, style)\n Then len(comment.pa... | user_story | [
{
"declaration": "(property getter) def paragraphs(self):",
"key": [
"docx.blkcntnr.BlockItemContainer",
"paragraphs"
]
},
{
"declaration": "def add_paragraph(self, text: str = \"\", style: str | ParagraphStyle | None = None) -> Paragraph:",
"key": [
"docx.comments.Comment"... | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-mutations.feature:33 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-mutations.feature",
"title": "Comment mutations",
"narrative": " In order to add and modify the content of a comment\n As a developer using python-docx\n I need mutation methods on Comment objects",
"background": null
} | {
"title": "Comment.add_paragraph() not specifying text or style",
"line": 33,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comment.add_paragraph() not specifying text or style\n Given a default Comment object\n When I assign paragraph = comment.add_paragraph()\n Then len(comment.paragra... | user_story | [
{
"declaration": "(property getter) def paragraphs(self):",
"key": [
"docx.blkcntnr.BlockItemContainer",
"paragraphs"
]
},
{
"declaration": "def add_paragraph(self, text: str = \"\", style: str | ParagraphStyle | None = None) -> Paragraph:",
"key": [
"docx.comments.Comment"... | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-mutations.feature:42 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-mutations.feature",
"title": "Comment mutations",
"narrative": " In order to add and modify the content of a comment\n As a developer using python-docx\n I need mutation methods on Comment objects",
"background": null
} | {
"title": "Add image to comment",
"line": 42,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add image to comment\n Given a default Comment object\n When I assign paragraph = comment.add_paragraph()\n And I assign run = paragraph.add_run()\n And I call run.add_picture()\n Then r... | user_story | [
{
"declaration": "def add_paragraph(self, text: str = \"\", style: str | ParagraphStyle | None = None) -> Paragraph:",
"key": [
"docx.comments.Comment",
"add_paragraph"
]
},
{
"declaration": "(property getter) def has_picture(self) -> bool:",
"key": [
"docx.drawing.Drawing"... | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-mutations.feature:50 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-mutations.feature",
"title": "Comment mutations",
"narrative": " In order to add and modify the content of a comment\n As a developer using python-docx\n I need mutation methods on Comment objects",
"background": null
} | {
"title": "update Comment.author",
"line": 50,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: update Comment.author\n Given a Comment object\n When I assign \"Jane Smith\" to comment.author\n Then comment.author == \"Jane Smith\""
} | user_story | [
{
"declaration": "(property getter) def author(self) -> str:",
"key": [
"docx.comments.Comment",
"author"
]
},
{
"declaration": "(property setter) def author(self, value: str):",
"key": [
"docx.comments.Comment",
"author.setter"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-mutations.feature:56 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-mutations.feature",
"title": "Comment mutations",
"narrative": " In order to add and modify the content of a comment\n As a developer using python-docx\n I need mutation methods on Comment objects",
"background": null
} | {
"title": "update Comment.initials",
"line": 56,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: update Comment.initials\n Given a Comment object\n When I assign \"JS\" to comment.initials\n Then comment.initials == \"JS\""
} | user_story | [
{
"declaration": "(property getter) def initials(self) -> str | None:",
"key": [
"docx.comments.Comment",
"initials"
]
},
{
"declaration": "(property setter) def initials(self, value: str | None):",
"key": [
"docx.comments.Comment",
"initials.setter"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-mutations.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-mutations.feature",
"title": "Comment mutations",
"narrative": " In order to add and modify the content of a comment\n As a developer using python-docx\n I need mutation methods on Comment objects",
"background": null
} | {
"title": "Comments.add_comment()",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comments.add_comment()\n Given a Comments object with 0 comments\n When I assign comment = comments.add_comment()\n Then comment.comment_id == 0\n And len(comment.paragraphs) == 1\n And... | user_story | [
{
"declaration": "(property getter) def paragraphs(self):",
"key": [
"docx.blkcntnr.BlockItemContainer",
"paragraphs"
]
},
{
"declaration": "(property getter) def comment_id(self) -> int:",
"key": [
"docx.comments.Comment",
"comment_id"
]
},
{
"declaration... | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-props.feature:12 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-props.feature",
"title": "Get comment properties",
"narrative": " In order to characterize comments by their metadata\n As a developer using python-docx\n I need methods to access comment metadata properties",
"background": null
} | {
"title": "Comment.author",
"line": 12,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comment.author\n Given a Comment object\n Then comment.author is the author of the comment"
} | user_story | [
{
"declaration": "(property getter) def author(self) -> str:",
"key": [
"docx.comments.Comment",
"author"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-props.feature:17 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-props.feature",
"title": "Get comment properties",
"narrative": " In order to characterize comments by their metadata\n As a developer using python-docx\n I need methods to access comment metadata properties",
"background": null
} | {
"title": "Comment.initials",
"line": 17,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comment.initials\n Given a Comment object\n Then comment.initials is the initials of the comment author"
} | user_story | [
{
"declaration": "(property getter) def initials(self) -> str | None:",
"key": [
"docx.comments.Comment",
"initials"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-props.feature:22 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-props.feature",
"title": "Get comment properties",
"narrative": " In order to characterize comments by their metadata\n As a developer using python-docx\n I need methods to access comment metadata properties",
"background": null
} | {
"title": "Comment.timestamp",
"line": 22,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comment.timestamp\n Given a Comment object\n Then comment.timestamp is the date and time the comment was authored"
} | user_story | [
{
"declaration": "(property getter) def timestamp(self) -> dt.datetime | None:",
"key": [
"docx.comments.Comment",
"timestamp"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-props.feature:27 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-props.feature",
"title": "Get comment properties",
"narrative": " In order to characterize comments by their metadata\n As a developer using python-docx\n I need methods to access comment metadata properties",
"background": null
} | {
"title": "Comment.paragraphs[0].text",
"line": 27,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comment.paragraphs[0].text\n Given a Comment object\n When I assign para_text = comment.paragraphs[0].text\n Then para_text is the text of the first paragraph in the comment"
} | user_story | [
{
"declaration": "(property getter) def paragraphs(self):",
"key": [
"docx.blkcntnr.BlockItemContainer",
"paragraphs"
]
},
{
"declaration": "(property getter) def text(self) -> str:",
"key": [
"docx.text.paragraph.Paragraph",
"text"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-props.feature:33 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-props.feature",
"title": "Get comment properties",
"narrative": " In order to characterize comments by their metadata\n As a developer using python-docx\n I need methods to access comment metadata properties",
"background": null
} | {
"title": "Retrieve embedded image from a comment",
"line": 33,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Retrieve embedded image from a comment\n Given a Comment object containing an embedded image\n Then I can extract the image from the comment"
} | user_story | [
{
"declaration": "(property getter) def paragraphs(self):",
"key": [
"docx.blkcntnr.BlockItemContainer",
"paragraphs"
]
},
{
"declaration": "(property getter) def has_picture(self) -> bool:",
"key": [
"docx.drawing.Drawing",
"has_picture"
]
},
{
"declarati... | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/cmt-props.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/cmt-props.feature",
"title": "Get comment properties",
"narrative": " In order to characterize comments by their metadata\n As a developer using python-docx\n I need methods to access comment metadata properties",
"background": null
} | {
"title": "Comment.id",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comment.id\n Given a Comment object\n Then comment.comment_id is the comment identifier"
} | user_story | [
{
"declaration": "(property getter) def comment_id(self) -> int:",
"key": [
"docx.comments.Comment",
"comment_id"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-access-collections.feature:12 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-access-collections.feature",
"title": "Access document collections",
"narrative": " In order to operate on objects related to a document\n As a developer using python-docx\n I need a way to access each of the document's collections",
"background": null
} | {
"title": "Access the paragraphs in the document body as a list",
"line": 12,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Access the paragraphs in the document body as a list\n Given a document containing three paragraphs\n Then document.paragraphs is a list containing three paragraphs"
... | user_story | [
{
"declaration": "(property getter) def paragraphs(self) -> List[Paragraph]:",
"key": [
"docx.document.Document",
"paragraphs"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/doc-access-collections.feature:17 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-access-collections.feature",
"title": "Access document collections",
"narrative": " In order to operate on objects related to a document\n As a developer using python-docx\n I need a way to access each of the document's collections",
"background": null
} | {
"title": "Access the section collection of a document",
"line": 17,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Access the section collection of a document\n Given a document having sections\n Then document.sections is a Sections object"
} | user_story | [
{
"declaration": "(property getter) def sections(self) -> Sections:",
"key": [
"docx.document.Document",
"sections"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-access-collections.feature:22 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-access-collections.feature",
"title": "Access document collections",
"narrative": " In order to operate on objects related to a document\n As a developer using python-docx\n I need a way to access each of the document's collections",
"background": null
} | {
"title": "Access the styles collection of a document",
"line": 22,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Access the styles collection of a document\n Given a document having styles\n Then document.styles is a Styles object"
} | user_story | [
{
"declaration": "(property getter) def styles(self):",
"key": [
"docx.document.Document",
"styles"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-access-collections.feature:27 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-access-collections.feature",
"title": "Access document collections",
"narrative": " In order to operate on objects related to a document\n As a developer using python-docx\n I need a way to access each of the document's collections",
"background": null
} | {
"title": "Access the tables collection of a document",
"line": 27,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Access the tables collection of a document\n Given a document having three tables\n Then document.tables is a list containing three tables"
} | user_story | [
{
"declaration": "(property getter) def tables(self) -> List[Table]:",
"key": [
"docx.document.Document",
"tables"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-access-collections.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-access-collections.feature",
"title": "Access document collections",
"narrative": " In order to operate on objects related to a document\n As a developer using python-docx\n I need a way to access each of the document's collections",
"background": null
} | {
"title": "Access the inline shapes collection of a document",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Access the inline shapes collection of a document\n Given a document having inline shapes\n Then document.inline_shapes is an InlineShapes object"
} | user_story | [
{
"declaration": "(property getter) def inline_shapes(self):",
"key": [
"docx.document.Document",
"inline_shapes"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-access-sections.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-access-sections.feature",
"title": "Access document sections",
"narrative": " In order to operate on an individual section\n As a developer using python-docx\n I need access to each section in the section collection",
"background": null
} | {
"title": "Access section in section collection",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Access section in section collection\n Given a section collection containing 3 sections\n Then len(sections) is 3\n And I can iterate over the sections\n And I can access ... | user_story | [
{
"declaration": "def __getitem__(self, key: int | slice) -> Section | List[Section]:",
"key": [
"docx.section.Sections",
"__getitem__"
]
},
{
"declaration": "def __iter__(self) -> Iterator[Section]:",
"key": [
"docx.section.Sections",
"__iter__"
]
},
{
"d... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/section.py"
] |
python-docx/features/doc-add-comment.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-comment.feature",
"title": "Add a comment to a document",
"narrative": " In order add a comment to a document\n As a developer using python-docx\n I need a way to add a comment specifying both its content and its reference",
"background": null
} | {
"title": "Document.add_comment(runs, text, author, initials)",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Document.add_comment(runs, text, author, initials)\n Given a document having a comments part\n When I assign comment = document.add_comment(runs, \"A comment\", \"John Doe... | user_story | [
{
"declaration": "(property getter) def author(self) -> str:",
"key": [
"docx.comments.Comment",
"author"
]
},
{
"declaration": "(property getter) def initials(self) -> str | None:",
"key": [
"docx.comments.Comment",
"initials"
]
},
{
"declaration": "(prop... | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-add-heading.feature:14 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-heading.feature",
"title": "Add a heading paragraph",
"narrative": " In order add a heading to a document\n As a developer using python-docx\n I need a way to add a heading with its text and level in a single step",
"background": null
} | {
"title": "Add a heading specifying level",
"line": 14,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Add a heading specifying level\n Given a document having built-in styles\n When I add a heading specifying level=<level>\n Then the style of the last paragraph is '<style>'\n\n ... | user_story | [
{
"declaration": "def add_heading(self, text: str = \"\", level: int = 1):",
"key": [
"docx.document.Document",
"add_heading"
]
},
{
"declaration": "(property getter) def paragraphs(self) -> List[Paragraph]:",
"key": [
"docx.document.Document",
"paragraphs"
]
},... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-add-heading.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-heading.feature",
"title": "Add a heading paragraph",
"narrative": " In order add a heading to a document\n As a developer using python-docx\n I need a way to add a heading with its text and level in a single step",
"background": null
} | {
"title": "Add a heading specifying only its text",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a heading specifying only its text\n Given a document having built-in styles\n When I add a heading specifying only its text\n Then the style of the last paragraph is 'Heading... | user_story | [
{
"declaration": "def add_heading(self, text: str = \"\", level: int = 1):",
"key": [
"docx.document.Document",
"add_heading"
]
},
{
"declaration": "(property getter) def paragraphs(self) -> List[Paragraph]:",
"key": [
"docx.document.Document",
"paragraphs"
]
},... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-add-page-break.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-page-break.feature",
"title": "Add a page break",
"narrative": " In order to force a page break at a particular location\n As a developer using the python-docx\n I need a way to add a hard page break on its own paragraph",
"background": null
} | {
"title": "Add a hard page break paragraph",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a hard page break paragraph\n Given a blank document\n When I add a page break to the document\n Then the last paragraph contains only a page break"
} | user_story | [
{
"declaration": "def add_page_break(self):",
"key": [
"docx.document.Document",
"add_page_break"
]
},
{
"declaration": "(property getter) def paragraphs(self) -> List[Paragraph]:",
"key": [
"docx.document.Document",
"paragraphs"
]
},
{
"declaration": "(pr... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-add-paragraph.feature:13 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-paragraph.feature",
"title": "Add a paragraph with optional text and style",
"narrative": " In order to populate the text of a document\n As a developer using python-docx\n I need a way to add a styled paragraph of text in a single step",
"background": null
} | {
"title": "Add a paragraph specifying its text",
"line": 13,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a paragraph specifying its text\n Given a blank document\n When I add a paragraph specifying its text\n Then the last paragraph contains the text I specified"
} | user_story | [
{
"declaration": "def add_paragraph(self, text: str = \"\", style: str | ParagraphStyle | None = None) -> Paragraph:",
"key": [
"docx.document.Document",
"add_paragraph"
]
},
{
"declaration": "(property getter) def paragraphs(self) -> List[Paragraph]:",
"key": [
"docx.docum... | null | system | PY-FACADE | true | [
"features/steps/api.py",
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-add-paragraph.feature:19 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-paragraph.feature",
"title": "Add a paragraph with optional text and style",
"narrative": " In order to populate the text of a document\n As a developer using python-docx\n I need a way to add a styled paragraph of text in a single step",
"background": null
} | {
"title": "Add a paragraph specifying its style",
"line": 19,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Add a paragraph specifying its style\n Given a document\n When I add a paragraph specifying its style as a <style-spec>\n Then the last paragraph has the style I specified\n... | user_story | [
{
"declaration": "def add_paragraph(self, text: str = \"\", style: str | ParagraphStyle | None = None) -> Paragraph:",
"key": [
"docx.document.Document",
"add_paragraph"
]
},
{
"declaration": "(property getter) def paragraphs(self) -> List[Paragraph]:",
"key": [
"docx.docum... | null | system | PY-FACADE | true | [
"features/steps/api.py",
"features/steps/document.py",
"features/steps/helpers.py",
"features/steps/shared.py"
] |
python-docx/features/doc-add-paragraph.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-paragraph.feature",
"title": "Add a paragraph with optional text and style",
"narrative": " In order to populate the text of a document\n As a developer using python-docx\n I need a way to add a styled paragraph of text in a single step",
"background": null
} | {
"title": "Add an empty paragraph",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add an empty paragraph\n Given a blank document\n When I add a paragraph without specifying text or style\n Then the last paragraph is the empty paragraph I added"
} | user_story | [
{
"declaration": "def add_paragraph(self, text: str = \"\", style: str | ParagraphStyle | None = None) -> Paragraph:",
"key": [
"docx.document.Document",
"add_paragraph"
]
},
{
"declaration": "(property getter) def paragraphs(self) -> List[Paragraph]:",
"key": [
"docx.docum... | null | system | PY-FACADE | true | [
"features/steps/api.py",
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-add-picture.feature:14 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-picture.feature",
"title": "Append an inline picture in its own paragraph",
"narrative": " In order add an image to a document\n As a developer using python-docx\n I need a way to add a picture in its own paragraph",
"background": null
} | {
"title": "Add a picture specifying both width and height",
"line": 14,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a picture specifying both width and height\n Given a blank document\n When I add a picture specifying 1.75\" width and 2.5\" height\n Then picture.width is 1.75 inche... | user_story | [
{
"declaration": "def add_picture( self, image_path_or_stream: str | IO[bytes], width: int | Length | None = None, height: int | Length | None = None, ):",
"key": [
"docx.document.Document",
"add_picture"
]
},
{
"declaration": "(property getter) def height(self) -> Length:",
"key... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py",
"features/steps/shape.py"
] |
python-docx/features/doc-add-picture.feature:21 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-picture.feature",
"title": "Append an inline picture in its own paragraph",
"narrative": " In order add an image to a document\n As a developer using python-docx\n I need a way to add a picture in its own paragraph",
"background": null
} | {
"title": "Add a picture specifying only width",
"line": 21,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a picture specifying only width\n Given a blank document\n When I add a picture specifying a width of 1.5 inches\n Then picture.height is 2.14 inches"
} | user_story | [
{
"declaration": "def add_picture( self, image_path_or_stream: str | IO[bytes], width: int | Length | None = None, height: int | Length | None = None, ):",
"key": [
"docx.document.Document",
"add_picture"
]
},
{
"declaration": "(property getter) def height(self) -> Length:",
"key... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py",
"features/steps/shape.py"
] |
python-docx/features/doc-add-picture.feature:27 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-picture.feature",
"title": "Append an inline picture in its own paragraph",
"narrative": " In order add an image to a document\n As a developer using python-docx\n I need a way to add a picture in its own paragraph",
"background": null
} | {
"title": "Add a picture specifying only height",
"line": 27,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a picture specifying only height\n Given a blank document\n When I add a picture specifying a height of 1.5 inches\n Then picture.width is 1.05 inches"
} | user_story | [
{
"declaration": "def add_picture( self, image_path_or_stream: str | IO[bytes], width: int | Length | None = None, height: int | Length | None = None, ):",
"key": [
"docx.document.Document",
"add_picture"
]
},
{
"declaration": "(property getter) def width(self):",
"key": [
... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py",
"features/steps/shape.py"
] |
python-docx/features/doc-add-picture.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-picture.feature",
"title": "Append an inline picture in its own paragraph",
"narrative": " In order add an image to a document\n As a developer using python-docx\n I need a way to add a picture in its own paragraph",
"background": null
} | {
"title": "Add a picture at native size",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a picture at native size\n Given a blank document\n When I add a picture specifying only the image file\n Then the document contains the inline picture\n And the picture has its na... | user_story | [
{
"declaration": "def add_picture( self, image_path_or_stream: str | IO[bytes], width: int | Length | None = None, height: int | Length | None = None, ):",
"key": [
"docx.document.Document",
"add_picture"
]
},
{
"declaration": "(property getter) def inline_shapes(self):",
"key": ... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py",
"features/steps/shape.py"
] |
python-docx/features/doc-add-section.feature:16 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-section.feature",
"title": "Add a document section",
"narrative": " In order to change page layout mid-document\n As a developer using python-docx\n I need a way to add a new section to a document",
"background": null
} | {
"title": "Document.add_section() adds a section that inherits headers and footers",
"line": 16,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Document.add_section() adds a section that inherits headers and footers\n Given a single-section Document object with headers and footers as document\n ... | user_story | [
{
"declaration": "def add_section(self, start_type: WD_SECTION = WD_SECTION.NEW_PAGE):",
"key": [
"docx.document.Document",
"add_section"
]
},
{
"declaration": "(property getter) def even_page_footer(self) -> _Footer:",
"key": [
"docx.section.Section",
"even_page_foot... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py",
"features/steps/section.py"
] |
python-docx/features/doc-add-section.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-section.feature",
"title": "Add a document section",
"narrative": " In order to change page layout mid-document\n As a developer using python-docx\n I need a way to add a new section to a document",
"background": null
} | {
"title": "Add a landscape section to a portrait document",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a landscape section to a portrait document\n Given a single-section document having portrait layout\n When I add an even-page section to the document\n And I chang... | user_story | [
{
"declaration": "def add_section(self, start_type: WD_SECTION = WD_SECTION.NEW_PAGE):",
"key": [
"docx.document.Document",
"add_section"
]
},
{
"declaration": "(property getter) def sections(self) -> Sections:",
"key": [
"docx.document.Document",
"sections"
]
}... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-add-table.feature:16 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-table.feature",
"title": "Add a table",
"narrative": " In order to include tablular information in a document\n As a developer using python-docx\n I need a way to add a table",
"background": null
} | {
"title": "Add a table specifying style",
"line": 16,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a table specifying style\n Given a document having built-in styles\n When I add a 2 x 2 table specifying style 'Table Grid'\n Then the document contains a 2 x 2 table\n And table.... | user_story | [
{
"declaration": "def add_table(self, rows: int, cols: int, style: str | _TableStyle | None = None):",
"key": [
"docx.document.Document",
"add_table"
]
},
{
"declaration": "(property getter) def styles(self):",
"key": [
"docx.document.Document",
"styles"
]
},
... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py",
"features/steps/table.py"
] |
python-docx/features/doc-add-table.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-add-table.feature",
"title": "Add a table",
"narrative": " In order to include tablular information in a document\n As a developer using python-docx\n I need a way to add a table",
"background": null
} | {
"title": "Add a table specifying only row and column count",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a table specifying only row and column count\n Given a blank document\n When I add a 2 x 2 table specifying only row and column count\n Then the document contains a ... | user_story | [
{
"declaration": "def add_table(self, rows: int, cols: int, style: str | _TableStyle | None = None):",
"key": [
"docx.document.Document",
"add_table"
]
},
{
"declaration": "(property getter) def styles(self):",
"key": [
"docx.document.Document",
"styles"
]
},
... | null | system | PY-FACADE | true | [
"features/steps/document.py",
"features/steps/helpers.py",
"features/steps/table.py"
] |
python-docx/features/doc-comments.feature:18 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-comments.feature",
"title": "Document.comments",
"narrative": " In order to operate on comments added to a document\n As a developer using python-docx\n I need access to the comments collection for the document\n And I need methods allowing access to the comments in the collection... | {
"title": "Comments.__len__()",
"line": 18,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Comments.__len__()\n Given a Comments object with <count> comments\n Then len(comments) == <count>\n\n Examples: len(comments) values\n | count |\n | 0 |\n | 4 |"
} | user_story | [
{
"declaration": "def __len__(self) -> int:",
"key": [
"docx.comments.Comments",
"__len__"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-comments.feature:28 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-comments.feature",
"title": "Document.comments",
"narrative": " In order to operate on comments added to a document\n As a developer using python-docx\n I need access to the comments collection for the document\n And I need methods allowing access to the comments in the collection... | {
"title": "Comments.__iter__()",
"line": 28,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comments.__iter__()\n Given a Comments object with 4 comments\n Then iterating comments yields 4 Comment objects"
} | user_story | [
{
"declaration": "def __iter__(self) -> Iterator[Comment]:",
"key": [
"docx.comments.Comments",
"__iter__"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-comments.feature:33 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-comments.feature",
"title": "Document.comments",
"narrative": " In order to operate on comments added to a document\n As a developer using python-docx\n I need access to the comments collection for the document\n And I need methods allowing access to the comments in the collection... | {
"title": "Comments.get()",
"line": 33,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Comments.get()\n Given a Comments object with 4 comments\n When I call comments.get(2)\n Then the result is a Comment object with id 2"
} | user_story | [
{
"declaration": "(property getter) def comment_id(self) -> int:",
"key": [
"docx.comments.Comment",
"comment_id"
]
},
{
"declaration": "def get(self, comment_id: int) -> Comment | None:",
"key": [
"docx.comments.Comments",
"get"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-comments.feature:8 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-comments.feature",
"title": "Document.comments",
"narrative": " In order to operate on comments added to a document\n As a developer using python-docx\n I need access to the comments collection for the document\n And I need methods allowing access to the comments in the collection... | {
"title": "Access document comments",
"line": 8,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Access document comments\n Given a document having <a-or-no> comments part\n Then document.comments is a Comments object\n\n Examples: having a comments part or not\n | a-or-no |\n ... | user_story | [
{
"declaration": "(property getter) def comments(self) -> Comments:",
"key": [
"docx.document.Document",
"comments"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/comments.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-coreprops.feature:13 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-coreprops.feature",
"title": "Read and write core document properties",
"narrative": " In order to find documents and make them manageable by digital means\n As a developer using python-docx\n I need to access and modify the Dublin Core metadata for a document",
"background": nul... | {
"title": "change the core properties of a document",
"line": 13,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: change the core properties of a document\n Given a document having known core properties\n When I assign new values to the properties\n Then the core property values match t... | user_story | [
{
"declaration": "(property getter) def core_properties(self):",
"key": [
"docx.document.Document",
"core_properties"
]
},
{
"declaration": "(property getter) def author(self):",
"key": [
"docx.opc.coreprops.CoreProperties",
"author"
]
},
{
"declaration": ... | null | system | PY-FACADE | true | [
"features/steps/coreprops.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-coreprops.feature:19 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-coreprops.feature",
"title": "Read and write core document properties",
"narrative": " In order to find documents and make them manageable by digital means\n As a developer using python-docx\n I need to access and modify the Dublin Core metadata for a document",
"background": nul... | {
"title": "a default core properties part is added if doc doesn't have one",
"line": 19,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: a default core properties part is added if doc doesn't have one\n Given a document having no core properties part\n When I access the core properties objec... | user_story | [
{
"declaration": "(property getter) def core_properties(self):",
"key": [
"docx.document.Document",
"core_properties"
]
},
{
"declaration": "(property getter) def last_modified_by(self):",
"key": [
"docx.opc.coreprops.CoreProperties",
"last_modified_by"
]
},
{... | null | system | PY-FACADE | true | [
"features/steps/coreprops.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-coreprops.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-coreprops.feature",
"title": "Read and write core document properties",
"narrative": " In order to find documents and make them manageable by digital means\n As a developer using python-docx\n I need to access and modify the Dublin Core metadata for a document",
"background": nul... | {
"title": "read the core properties of a document",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: read the core properties of a document\n Given a document having known core properties\n Then I can access the core properties object\n And the core property values match the ... | user_story | [
{
"declaration": "(property getter) def core_properties(self):",
"key": [
"docx.document.Document",
"core_properties"
]
},
{
"declaration": "(property getter) def author(self):",
"key": [
"docx.opc.coreprops.CoreProperties",
"author"
]
},
{
"declaration": ... | null | system | PY-FACADE | true | [
"features/steps/coreprops.py",
"features/steps/helpers.py"
] |
python-docx/features/doc-settings.feature:18 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-settings.feature",
"title": "Document.settings",
"narrative": " In order to operate on document-level settings\n As a developer using python-docx\n I need access to settings to the Settings object for the document\n And I need properties and methods on Settings",
"background": n... | {
"title": "Settings.odd_and_even_pages_header_footer getter",
"line": 18,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Settings.odd_and_even_pages_header_footer getter\n Given a Settings object <with-or-without> odd and even page headers as settings\n Then settings.odd_and_even_pages... | user_story | [
{
"declaration": "(property getter) def odd_and_even_pages_header_footer(self) -> bool:",
"key": [
"docx.settings.Settings",
"odd_and_even_pages_header_footer"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/settings.py"
] |
python-docx/features/doc-settings.feature:28 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-settings.feature",
"title": "Document.settings",
"narrative": " In order to operate on document-level settings\n As a developer using python-docx\n I need access to settings to the Settings object for the document\n And I need properties and methods on Settings",
"background": n... | {
"title": "Settings.odd_and_even_pages_header_footer setter",
"line": 28,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Settings.odd_and_even_pages_header_footer setter\n Given a Settings object <with-or-without> odd and even page headers as settings\n When I assign <value> to setting... | user_story | [
{
"declaration": "(property getter) def odd_and_even_pages_header_footer(self) -> bool:",
"key": [
"docx.settings.Settings",
"odd_and_even_pages_header_footer"
]
},
{
"declaration": "(property setter) def odd_and_even_pages_header_footer(self, value: bool):",
"key": [
"docx... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/settings.py"
] |
python-docx/features/doc-settings.feature:8 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-settings.feature",
"title": "Document.settings",
"narrative": " In order to operate on document-level settings\n As a developer using python-docx\n I need access to settings to the Settings object for the document\n And I need properties and methods on Settings",
"background": n... | {
"title": "Access document settings",
"line": 8,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Access document settings\n Given a document having <a-or-no> settings part\n Then document.settings is a Settings object\n\n Examples: having a settings part or not\n | a-or-no |\n... | user_story | [
{
"declaration": "(property getter) def settings(self) -> Settings:",
"key": [
"docx.document.Document",
"settings"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/settings.py"
] |
python-docx/features/doc-styles.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/doc-styles.feature",
"title": "Access a document style",
"narrative": " In order to operate on a particular document style\n As a developer using python-docx\n I access to each style in the document style collection",
"background": null
} | {
"title": "Access style in style collection",
"line": 7,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Access style in style collection\n Given a document having <styles-state>\n Then len(styles) is <style-count>\n And I can iterate over its styles\n And I can access a style... | user_story | [
{
"declaration": "(property getter) def styles(self):",
"key": [
"docx.document.Document",
"styles"
]
},
{
"declaration": "def __getitem__(self, key: str):",
"key": [
"docx.styles.styles.Styles",
"__getitem__"
]
},
{
"declaration": "def __iter__(self):",
... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/styles.py"
] |
python-docx/features/hdr-header-footer.feature:17 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Header.is_linked_to_previous setter",
"line": 17,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: _Header.is_linked_to_previous setter\n Given a _Header object <with-or-no> header definition as header\n When I assign <value> to header.is_linked_to_previous\n Then header.... | user_story | [
{
"declaration": "(property getter) def is_linked_to_previous(self) -> bool:",
"key": [
"docx.section._BaseHeaderFooter",
"is_linked_to_previous"
]
},
{
"declaration": "(property setter) def is_linked_to_previous(self, value: bool) -> None:",
"key": [
"docx.section._BaseHea... | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hdr-header-footer.feature:30 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Header inherits content",
"line": 30,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: _Header inherits content\n Given a _Header object with a header definition as header\n And the next _Header object with no header definition as header_2\n Then header_2.paragraphs[0].text == ... | user_story | [
{
"declaration": "(property getter) def paragraphs(self):",
"key": [
"docx.blkcntnr.BlockItemContainer",
"paragraphs"
]
},
{
"declaration": "(property getter) def is_linked_to_previous(self) -> bool:",
"key": [
"docx.section._BaseHeaderFooter",
"is_linked_to_previous"... | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hdr-header-footer.feature:37 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Header text accepts style assignment",
"line": 37,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: _Header text accepts style assignment\n Given a _Header object with a header definition as header\n When I assign \"Normal\" to header.paragraphs[0].style\n Then header.paragraphs... | user_story | [
{
"declaration": "(property getter) def paragraphs(self):",
"key": [
"docx.blkcntnr.BlockItemContainer",
"paragraphs"
]
},
{
"declaration": "(property getter) def name(self):",
"key": [
"docx.styles.style.BaseStyle",
"name"
]
},
{
"declaration": "(property... | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hdr-header-footer.feature:43 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Header allows image insertion",
"line": 43,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: _Header allows image insertion\n Given a _Run object from a header as run\n When I call run.add_picture()\n Then I can't detect the image but no exception is raised"
} | user_story | [
{
"declaration": "def add_picture( self, image_path_or_stream: str | IO[bytes], width: int | Length | None = None, height: int | Length | None = None, ) -> InlineShape:",
"key": [
"docx.text.run.Run",
"add_picture"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hdr-header-footer.feature:49 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Footer.is_linked_to_previous getter",
"line": 49,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: _Footer.is_linked_to_previous getter\n Given a _Footer object <with-or-no> footer definition as footer\n Then footer.is_linked_to_previous is <value>\n\n Examples: _Footer.is... | user_story | [
{
"declaration": "(property getter) def is_linked_to_previous(self) -> bool:",
"key": [
"docx.section._BaseHeaderFooter",
"is_linked_to_previous"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hdr-header-footer.feature:59 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Footer.is_linked_to_previous setter",
"line": 59,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: _Footer.is_linked_to_previous setter\n Given a _Footer object <with-or-no> footer definition as footer\n When I assign <value> to footer.is_linked_to_previous\n Then footer.... | user_story | [
{
"declaration": "(property getter) def is_linked_to_previous(self) -> bool:",
"key": [
"docx.section._BaseHeaderFooter",
"is_linked_to_previous"
]
},
{
"declaration": "(property setter) def is_linked_to_previous(self, value: bool) -> None:",
"key": [
"docx.section._BaseHea... | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hdr-header-footer.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Header.is_linked_to_previous getter",
"line": 7,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: _Header.is_linked_to_previous getter\n Given a _Header object <with-or-no> header definition as header\n Then header.is_linked_to_previous is <value>\n\n Examples: _Header.is_... | user_story | [
{
"declaration": "(property getter) def is_linked_to_previous(self) -> bool:",
"key": [
"docx.section._BaseHeaderFooter",
"is_linked_to_previous"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hdr-header-footer.feature:72 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Footer inherits content",
"line": 72,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: _Footer inherits content\n Given a _Footer object with a footer definition as footer\n And the next _Footer object with no footer definition as footer_2\n Then footer_2.paragraphs[0].text == ... | user_story | [
{
"declaration": "(property getter) def paragraphs(self):",
"key": [
"docx.blkcntnr.BlockItemContainer",
"paragraphs"
]
},
{
"declaration": "(property getter) def is_linked_to_previous(self) -> bool:",
"key": [
"docx.section._BaseHeaderFooter",
"is_linked_to_previous"... | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hdr-header-footer.feature:79 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Footer text accepts style assignment",
"line": 79,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: _Footer text accepts style assignment\n Given a _Footer object with a footer definition as footer\n When I assign \"Normal\" to footer.paragraphs[0].style\n Then footer.paragraphs... | user_story | [
{
"declaration": "(property getter) def paragraphs(self):",
"key": [
"docx.blkcntnr.BlockItemContainer",
"paragraphs"
]
},
{
"declaration": "(property getter) def name(self):",
"key": [
"docx.styles.style.BaseStyle",
"name"
]
},
{
"declaration": "(property... | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hdr-header-footer.feature:85 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hdr-header-footer.feature",
"title": "Header and footer behaviors",
"narrative": " In order to control the appearance of page headers and footers\n As a developer using python-docx\n I need properties and methods on _Header and _Footer objects",
"background": null
} | {
"title": "_Footer allows image insertion",
"line": 85,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: _Footer allows image insertion\n Given a _Run object from a footer as run\n When I call run.add_picture()\n Then I can't detect the image but no exception is raised"
} | user_story | [
{
"declaration": "def add_picture( self, image_path_or_stream: str | IO[bytes], width: int | Length | None = None, height: int | Length | None = None, ) -> InlineShape:",
"key": [
"docx.text.run.Run",
"add_picture"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/hdrftr.py",
"features/steps/helpers.py"
] |
python-docx/features/hlk-props.feature:12 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hlk-props.feature",
"title": "Access hyperlink properties",
"narrative": " In order to access the URL and other details for a hyperlink\n As a developer using python-docx\n I need properties on Hyperlink",
"background": null
} | {
"title": "Hyperlink.contains_page_break reports presence of page-break",
"line": 12,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Hyperlink.contains_page_break reports presence of page-break\n Given a hyperlink having <zero-or-more> rendered page breaks\n Then hyperlink.contains_pag... | user_story | [
{
"declaration": "(property getter) def contains_page_break(self) -> bool:",
"key": [
"docx.text.hyperlink.Hyperlink",
"contains_page_break"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/hyperlink.py"
] |
python-docx/features/hlk-props.feature:22 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hlk-props.feature",
"title": "Access hyperlink properties",
"narrative": " In order to access the URL and other details for a hyperlink\n As a developer using python-docx\n I need properties on Hyperlink",
"background": null
} | {
"title": "Hyperlink.fragment has the URI fragment of the hyperlink",
"line": 22,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Hyperlink.fragment has the URI fragment of the hyperlink\n Given a hyperlink having a URI fragment\n Then hyperlink.fragment is the URI fragment of the hyperlink"
} | user_story | [
{
"declaration": "(property getter) def fragment(self) -> str:",
"key": [
"docx.text.hyperlink.Hyperlink",
"fragment"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/hyperlink.py"
] |
python-docx/features/hlk-props.feature:27 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hlk-props.feature",
"title": "Access hyperlink properties",
"narrative": " In order to access the URL and other details for a hyperlink\n As a developer using python-docx\n I need properties on Hyperlink",
"background": null
} | {
"title": "Hyperlink.runs contains Run for each run in hyperlink",
"line": 27,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Hyperlink.runs contains Run for each run in hyperlink\n Given a hyperlink having <zero-or-more> runs\n Then hyperlink.runs has length <value>\n And hyperli... | user_story | [
{
"declaration": "(property getter) def runs(self) -> list[Run]:",
"key": [
"docx.text.hyperlink.Hyperlink",
"runs"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/hyperlink.py"
] |
python-docx/features/hlk-props.feature:38 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hlk-props.feature",
"title": "Access hyperlink properties",
"narrative": " In order to access the URL and other details for a hyperlink\n As a developer using python-docx\n I need properties on Hyperlink",
"background": null
} | {
"title": "Hyperlink.text has the visible text of the hyperlink",
"line": 38,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Hyperlink.text has the visible text of the hyperlink\n Given a hyperlink\n Then hyperlink.text is the visible text of the hyperlink"
} | user_story | [
{
"declaration": "(property getter) def text(self) -> str:",
"key": [
"docx.text.hyperlink.Hyperlink",
"text"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/hyperlink.py"
] |
python-docx/features/hlk-props.feature:43 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hlk-props.feature",
"title": "Access hyperlink properties",
"narrative": " In order to access the URL and other details for a hyperlink\n As a developer using python-docx\n I need properties on Hyperlink",
"background": null
} | {
"title": "Hyperlink.url is the full URL of an internet hyperlink",
"line": 43,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Hyperlink.url is the full URL of an internet hyperlink\n Given a hyperlink having address <address> and fragment <fragment>\n Then hyperlink.url is <url>\n\n ... | user_story | [
{
"declaration": "(property getter) def url(self) -> str:",
"key": [
"docx.text.hyperlink.Hyperlink",
"url"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/hyperlink.py"
] |
python-docx/features/hlk-props.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/hlk-props.feature",
"title": "Access hyperlink properties",
"narrative": " In order to access the URL and other details for a hyperlink\n As a developer using python-docx\n I need properties on Hyperlink",
"background": null
} | {
"title": "Hyperlink.address has the URL of the hyperlink",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Hyperlink.address has the URL of the hyperlink\n Given a hyperlink\n Then hyperlink.address is the URL of the hyperlink"
} | user_story | [
{
"declaration": "(property getter) def address(self) -> str:",
"key": [
"docx.text.hyperlink.Hyperlink",
"address"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/hyperlink.py"
] |
python-docx/features/img-characterize-image.feature:6 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/img-characterize-image.feature",
"title": "Characterize an image file",
"narrative": " In order to add a picture to a document\n As a programmer using the advanced python-docx API\n I need a way to determine the image content type and size",
"background": null
} | {
"title": "Characterize an image file",
"line": 6,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Characterize an image file\n Given the image file '<filename>'\n When I construct an image using the image path\n Then the image has content type '<mime_type>'\n And the image is ... | user_story | [
{
"declaration": "(property getter) def content_type(self) -> str:",
"key": [
"docx.image.image.Image",
"content_type"
]
},
{
"declaration": "def from_file(cls, image_descriptor: str | IO[bytes]):",
"key": [
"docx.image.image.Image",
"from_file"
]
},
{
"de... | null | component | PY-DIRECT | true | [
"features/steps/helpers.py",
"features/steps/image.py"
] |
python-docx/features/num-access-numbering-part.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/num-access-numbering-part.feature",
"title": "Access the document numbering part",
"narrative": " In order to operate on numbering settings\n As a developer using python-docx\n I need access to the numbering part of the document",
"background": null
} | {
"title": "Get an existing numbering part from document",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Get an existing numbering part from document\n Given a document having a numbering part\n When I get the numbering part from the document\n Then the numbering part has the e... | user_story | [
{
"declaration": "(property getter) def part(self) -> DocumentPart:",
"key": [
"docx.document.Document",
"part"
]
},
{
"declaration": "(property getter) def numbering_part(self) -> NumberingPart:",
"key": [
"docx.parts.document.DocumentPart",
"numbering_part"
]
... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/numbering.py"
] |
python-docx/features/par-access-inner-content.feature:18 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-access-inner-content.feature",
"title": "Access paragraph inner-content including hyperlinks",
"narrative": " In order to extract paragraph content with high-fidelity\n As a developer using python-docx\n I need to access differentiated paragraph content in document order",
"backg... | {
"title": "Paragraph.hyperlinks contains Hyperlink for each link in paragraph",
"line": 18,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Paragraph.hyperlinks contains Hyperlink for each link in paragraph\n Given a paragraph having <zero-or-more> hyperlinks\n Then paragraph.hyperlinks... | user_story | [
{
"declaration": "(property getter) def hyperlinks(self) -> List[Hyperlink]:",
"key": [
"docx.text.paragraph.Paragraph",
"hyperlinks"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-access-inner-content.feature:30 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-access-inner-content.feature",
"title": "Access paragraph inner-content including hyperlinks",
"narrative": " In order to extract paragraph content with high-fidelity\n As a developer using python-docx\n I need to access differentiated paragraph content in document order",
"backg... | {
"title": "Paragraph.iter_inner_content() generates the paragraph's runs and hyperlinks",
"line": 30,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Paragraph.iter_inner_content() generates the paragraph's runs and hyperlinks\n Given a paragraph having three hyperlinks\n Then paragraph.iter_i... | user_story | [
{
"declaration": "def iter_inner_content(self) -> Iterator[Run | Hyperlink]:",
"key": [
"docx.text.paragraph.Paragraph",
"iter_inner_content"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-access-inner-content.feature:35 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-access-inner-content.feature",
"title": "Access paragraph inner-content including hyperlinks",
"narrative": " In order to extract paragraph content with high-fidelity\n As a developer using python-docx\n I need to access differentiated paragraph content in document order",
"backg... | {
"title": "Paragraph.rendered_page_breaks contains paragraph RenderedPageBreaks",
"line": 35,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Paragraph.rendered_page_breaks contains paragraph RenderedPageBreaks\n Given a paragraph having <zero-or-more> rendered page breaks\n Then paragr... | user_story | [
{
"declaration": "(property getter) def rendered_page_breaks(self) -> List[RenderedPageBreak]:",
"key": [
"docx.text.paragraph.Paragraph",
"rendered_page_breaks"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-access-inner-content.feature:47 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-access-inner-content.feature",
"title": "Access paragraph inner-content including hyperlinks",
"narrative": " In order to extract paragraph content with high-fidelity\n As a developer using python-docx\n I need to access differentiated paragraph content in document order",
"backg... | {
"title": "Paragraph.text contains both run-text and hyperlink-text",
"line": 47,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Paragraph.text contains both run-text and hyperlink-text\n Given a paragraph having three hyperlinks\n Then paragraph.text contains the text of both the runs and th... | user_story | [
{
"declaration": "(property getter) def text(self) -> str:",
"key": [
"docx.text.paragraph.Paragraph",
"text"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-access-inner-content.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-access-inner-content.feature",
"title": "Access paragraph inner-content including hyperlinks",
"narrative": " In order to extract paragraph content with high-fidelity\n As a developer using python-docx\n I need to access differentiated paragraph content in document order",
"backg... | {
"title": "Paragraph.contains_page_break reports presence of page-break",
"line": 7,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Paragraph.contains_page_break reports presence of page-break\n Given a paragraph having <zero-or-more> rendered page breaks\n Then paragraph.contains_page... | user_story | [
{
"declaration": "(property getter) def contains_page_break(self) -> bool:",
"key": [
"docx.text.paragraph.Paragraph",
"contains_page_break"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-access-parfmt.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-access-parfmt.feature",
"title": "Access paragraph format",
"narrative": " In order to get or change the formatting of a paragraph\n As a developer using python-docx\n I need access to the paragraph format of a paragraph",
"background": null
} | {
"title": "Get paragraph format object",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Get paragraph format object\n Given a paragraph\n Then paragraph.paragraph_format is its ParagraphFormat object"
} | user_story | [
{
"declaration": "(property getter) def element(self):",
"key": [
"docx.shared.ElementProxy",
"element"
]
},
{
"declaration": "(property getter) def paragraph_format(self):",
"key": [
"docx.text.paragraph.Paragraph",
"paragraph_format"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/block.py",
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-add-run.feature:13 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-add-run.feature",
"title": "Add a run with optional text and style",
"narrative": " In order to add distinctively formatted text to a paragraph\n As a python-docx programmer\n I want a way to add a styled run of text in a single step",
"background": null
} | {
"title": "Add a run specifying its style",
"line": 13,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a run specifying its style\n Given a paragraph\n When I add a run specifying the character style Emphasis\n Then run.style is styles['Emphasis']"
} | user_story | [
{
"declaration": "(property getter) def styles(self):",
"key": [
"docx.document.Document",
"styles"
]
},
{
"declaration": "def __eq__(self, other: object):",
"key": [
"docx.shared.ElementProxy",
"__eq__"
]
},
{
"declaration": "def __getitem__(self, key: st... | null | system | PY-FACADE | true | [
"features/steps/block.py",
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/par-add-run.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-add-run.feature",
"title": "Add a run with optional text and style",
"narrative": " In order to add distinctively formatted text to a paragraph\n As a python-docx programmer\n I want a way to add a styled run of text in a single step",
"background": null
} | {
"title": "Add a run specifying its text",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a run specifying its text\n Given a paragraph\n When I add a run specifying its text\n Then the run contains the text I specified"
} | user_story | [
{
"declaration": "def add_run(self, text: str | None = None, style: str | CharacterStyle | None = None) -> Run:",
"key": [
"docx.text.paragraph.Paragraph",
"add_run"
]
},
{
"declaration": "(property getter) def text(self) -> str:",
"key": [
"docx.text.run.Run",
"text"... | null | system | PY-FACADE | true | [
"features/steps/block.py",
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/par-alignment-prop.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-alignment-prop.feature",
"title": "Get or set paragraph alignment",
"narrative": " In order to specify the justification of a paragraph\n As a python-docx developer\n I need a read/write alignment property on paragraph objects",
"background": null
} | {
"title": "Get paragraph alignment",
"line": 7,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Get paragraph alignment\n Given a paragraph having <align-type> alignment\n Then the paragraph alignment property value is <align-value>\n\n Examples: align property values\n | align-... | user_story | [
{
"declaration": "(property getter) def alignment(self) -> WD_PARAGRAPH_ALIGNMENT | None:",
"key": [
"docx.text.paragraph.Paragraph",
"alignment"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-clear-paragraph.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-clear-paragraph.feature",
"title": "Clear paragraph content",
"narrative": " In order to change paragraph content while retaining its formatting\n As a developer using python-docx\n I need a way to remove the content of a paragraph",
"background": null
} | {
"title": "Clear paragraph content",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Clear paragraph content\n Given a paragraph with content and formatting\n When I clear the paragraph content\n Then the paragraph has no content\n But the paragraph formatting is preserved"... | user_story | [
{
"declaration": "(property getter) def name(self):",
"key": [
"docx.styles.style.BaseStyle",
"name"
]
},
{
"declaration": "def clear(self):",
"key": [
"docx.text.paragraph.Paragraph",
"clear"
]
},
{
"declaration": "(property getter) def style(self) -> Par... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-insert-paragraph.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-insert-paragraph.feature",
"title": "Insert a paragraph before or after a paragraph",
"narrative": " In order to add new content in the middle of an existing document\n As a developer using python-docx\n I need a way to insert a paragraph relative to another paragraph",
"backgrou... | {
"title": "Add a new paragraph above an existing paragraph",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a new paragraph above an existing paragraph\n Given a document containing three paragraphs\n When I insert a paragraph above the second paragraph\n Then the document ... | user_story | [
{
"declaration": "(property getter) def paragraphs(self) -> List[Paragraph]:",
"key": [
"docx.document.Document",
"paragraphs"
]
},
{
"declaration": "(property getter) def name(self):",
"key": [
"docx.styles.style.BaseStyle",
"name"
]
},
{
"declaration": "... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-set-text.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-set-text.feature",
"title": "Replace paragraph text",
"narrative": " In order to conveniently change the text of a paragraph in place\n As a developer using python-docx\n I need a writable text property on paragraph",
"background": null
} | {
"title": "Set paragraph text",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Set paragraph text\n Given a paragraph with content and formatting\n When I set the paragraph text\n Then the paragraph has the text I set\n And the paragraph formatting is preserved"
} | user_story | [
{
"declaration": "(property getter) def name(self):",
"key": [
"docx.styles.style.BaseStyle",
"name"
]
},
{
"declaration": "(property getter) def style(self) -> ParagraphStyle | None:",
"key": [
"docx.text.paragraph.Paragraph",
"style"
]
},
{
"declaration"... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-style-prop.feature:19 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-style-prop.feature",
"title": "Each paragraph has a read/write style",
"narrative": " In order to use the stylesheet capability built into Word\n As a developer using python-docx\n I need the ability to get and set the style of a paragraph",
"background": null
} | {
"title": "Set the style of a paragraph",
"line": 19,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Set the style of a paragraph\n Given a paragraph\n When I assign a <style-spec> to paragraph.style\n Then the paragraph has the style I set\n\n Examples: ways of specifying a ... | user_story | [
{
"declaration": "(property getter) def styles(self):",
"key": [
"docx.document.Document",
"styles"
]
},
{
"declaration": "def __eq__(self, other: object):",
"key": [
"docx.shared.ElementProxy",
"__eq__"
]
},
{
"declaration": "def __getitem__(self, key: st... | null | system | PY-FACADE | true | [
"features/steps/block.py",
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/par-style-prop.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/par-style-prop.feature",
"title": "Each paragraph has a read/write style",
"narrative": " In order to use the stylesheet capability built into Word\n As a developer using python-docx\n I need the ability to get and set the style of a paragraph",
"background": null
} | {
"title": "Get the style of a paragraph",
"line": 7,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Get the style of a paragraph\n Given a paragraph having <style> style\n Then paragraph.style is <expected-value>\n\n Examples: ways of specifying a style\n | style | exp... | user_story | [
{
"declaration": "(property getter) def styles(self):",
"key": [
"docx.document.Document",
"styles"
]
},
{
"declaration": "def __eq__(self, other: object):",
"key": [
"docx.shared.ElementProxy",
"__eq__"
]
},
{
"declaration": "def __getitem__(self, key: st... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/paragraph.py"
] |
python-docx/features/pbk-split-para.feature:12 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/pbk-split-para.feature",
"title": "Split paragraph on rendered page-breaks",
"narrative": " In order to extract document content with high page-attribution fidelity\n As a developer using python-docx\n I need to a way to split a paragraph on its first rendered page break",
"backgroun... | {
"title": "RenderedPageBreak.preceding_paragraph_fragment includes the hyperlink",
"line": 12,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: RenderedPageBreak.preceding_paragraph_fragment includes the hyperlink\n Given a rendered_page_break in a hyperlink\n Then rendered_page_break.preceding... | user_story | [
{
"declaration": "(property getter) def name(self):",
"key": [
"docx.styles.style.BaseStyle",
"name"
]
},
{
"declaration": "(property getter) def address(self) -> str:",
"key": [
"docx.text.hyperlink.Hyperlink",
"address"
]
},
{
"declaration": "(property g... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/pagebreak.py"
] |
python-docx/features/pbk-split-para.feature:17 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/pbk-split-para.feature",
"title": "Split paragraph on rendered page-breaks",
"narrative": " In order to extract document content with high page-attribution fidelity\n As a developer using python-docx\n I need to a way to split a paragraph on its first rendered page break",
"backgroun... | {
"title": "RenderedPageBreak.following_paragraph_fragment is the content after break",
"line": 17,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: RenderedPageBreak.following_paragraph_fragment is the content after break\n Given a rendered_page_break in a paragraph\n Then rendered_page_break.f... | user_story | [
{
"declaration": "(property getter) def name(self):",
"key": [
"docx.styles.style.BaseStyle",
"name"
]
},
{
"declaration": "(property getter) def following_paragraph_fragment(self) -> Paragraph | None:",
"key": [
"docx.text.pagebreak.RenderedPageBreak",
"following_par... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/pagebreak.py"
] |
python-docx/features/pbk-split-para.feature:22 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/pbk-split-para.feature",
"title": "Split paragraph on rendered page-breaks",
"narrative": " In order to extract document content with high page-attribution fidelity\n As a developer using python-docx\n I need to a way to split a paragraph on its first rendered page break",
"backgroun... | {
"title": "RenderedPageBreak.following_paragraph_fragment excludes the hyperlink",
"line": 22,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: RenderedPageBreak.following_paragraph_fragment excludes the hyperlink\n Given a rendered_page_break in a hyperlink\n Then rendered_page_break.following... | user_story | [
{
"declaration": "(property getter) def following_paragraph_fragment(self) -> Paragraph | None:",
"key": [
"docx.text.pagebreak.RenderedPageBreak",
"following_paragraph_fragment"
]
},
{
"declaration": "(property getter) def alignment(self) -> WD_PARAGRAPH_ALIGNMENT | None:",
"key... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/pagebreak.py"
] |
python-docx/features/pbk-split-para.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/pbk-split-para.feature",
"title": "Split paragraph on rendered page-breaks",
"narrative": " In order to extract document content with high page-attribution fidelity\n As a developer using python-docx\n I need to a way to split a paragraph on its first rendered page break",
"backgroun... | {
"title": "RenderedPageBreak.preceding_paragraph_fragment is the content before break",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: RenderedPageBreak.preceding_paragraph_fragment is the content before break\n Given a rendered_page_break in a paragraph\n Then rendered_page_break.... | user_story | [
{
"declaration": "(property getter) def name(self):",
"key": [
"docx.styles.style.BaseStyle",
"name"
]
},
{
"declaration": "(property getter) def preceding_paragraph_fragment(self) -> Paragraph | None:",
"key": [
"docx.text.pagebreak.RenderedPageBreak",
"preceding_par... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/pagebreak.py"
] |
python-docx/features/run-access-font.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-access-font.feature",
"title": "Access run font",
"narrative": " In order to discover or change the character formatting of a run\n As a developer using python-docx\n I need access to the font of a run",
"background": null
} | {
"title": "Access the font of a run",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Access the font of a run\n Given a run\n Then run.font is the Font object for the run"
} | user_story | [
{
"declaration": "(property getter) def element(self):",
"key": [
"docx.shared.ElementProxy",
"element"
]
},
{
"declaration": "(property getter) def font(self) -> Font:",
"key": [
"docx.text.run.Run",
"font"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-access-inner-content.feature:18 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-access-inner-content.feature",
"title": "Access run inner-content including rendered page-breaks",
"narrative": " In order to extract run content with high-fidelity\n As a developer using python-docx\n I need to access differentiated run content in document order",
"background": ... | {
"title": "Run.iter_inner_content() generates the run's text and rendered page-breaks",
"line": 18,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Run.iter_inner_content() generates the run's text and rendered page-breaks\n Given a run having two rendered page breaks\n Then run.iter_inner_con... | user_story | [
{
"declaration": "def iter_inner_content(self) -> Iterator[str | Drawing | RenderedPageBreak]:",
"key": [
"docx.text.run.Run",
"iter_inner_content"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-access-inner-content.feature:23 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-access-inner-content.feature",
"title": "Access run inner-content including rendered page-breaks",
"narrative": " In order to extract run content with high-fidelity\n As a developer using python-docx\n I need to access differentiated run content in document order",
"background": ... | {
"title": "Run.text contains the text content of the run",
"line": 23,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Run.text contains the text content of the run\n Given a run having mixed text content\n Then run.text contains the text content of the run"
} | user_story | [
{
"declaration": "(property getter) def text(self) -> str:",
"key": [
"docx.text.run.Run",
"text"
]
}
] | null | component | PY-DIRECT | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-access-inner-content.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-access-inner-content.feature",
"title": "Access run inner-content including rendered page-breaks",
"narrative": " In order to extract run content with high-fidelity\n As a developer using python-docx\n I need to access differentiated run content in document order",
"background": ... | {
"title": "Run.contains_page_break reports presence of page-break",
"line": 7,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Run.contains_page_break reports presence of page-break\n Given a run having <zero-or-more> rendered page breaks\n Then run.contains_page_break is <value>\n\n ... | user_story | [
{
"declaration": "(property getter) def contains_page_break(self) -> bool:",
"key": [
"docx.text.run.Run",
"contains_page_break"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-add-content.feature:11 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-add-content.feature",
"title": "Add content to a run",
"narrative": " In order to populate a run with varied content\n As a developer using python-docx\n I need a way to add each of the run content elements to a run",
"background": null
} | {
"title": "Assign mixed text to text property",
"line": 11,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Assign mixed text to text property\n Given a run\n When I assign mixed text to the text property\n Then run.text contains the text content of the run"
} | user_story | [
{
"declaration": "(property getter) def text(self) -> str:",
"key": [
"docx.text.run.Run",
"text"
]
},
{
"declaration": "(property setter) def text(self, text: str):",
"key": [
"docx.text.run.Run",
"text.setter"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-add-content.feature:6 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-add-content.feature",
"title": "Add content to a run",
"narrative": " In order to populate a run with varied content\n As a developer using python-docx\n I need a way to add each of the run content elements to a run",
"background": null
} | {
"title": "Add a tab",
"line": 6,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a tab\n Given a run\n When I add a tab\n Then the tab appears at the end of the run"
} | user_story | [
{
"declaration": "def qn(tag: str) -> str:",
"key": [
"docx.oxml.ns",
"qn"
]
},
{
"declaration": "def add_tab(self) -> None:",
"key": [
"docx.text.run.Run",
"add_tab"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-add-picture.feature:14 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-add-picture.feature",
"title": "Add picture to a run",
"narrative": " In order to place an inline picture at an arbitrary place in a document\n As a developer using python-docx\n I need a way to add a picture to a run",
"background": null
} | {
"title": "Add a picture to a run in a table cell",
"line": 14,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Add a picture to a run in a table cell\n Given a run inside a table cell retrieved from <cell-source>\n When I add a picture to the run\n Then the picture appears at the e... | user_story | [
{
"declaration": "(property getter) def inline_shapes(self):",
"key": [
"docx.document.Document",
"inline_shapes"
]
},
{
"declaration": "(property getter) def part(self) -> DocumentPart:",
"key": [
"docx.document.Document",
"part"
]
},
{
"declaration": "(p... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/shape.py",
"features/steps/text.py"
] |
python-docx/features/run-add-picture.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-add-picture.feature",
"title": "Add picture to a run",
"narrative": " In order to place an inline picture at an arbitrary place in a document\n As a developer using python-docx\n I need a way to add a picture to a run",
"background": null
} | {
"title": "Add a picture to a body paragraph run",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Add a picture to a body paragraph run\n Given a run\n When I add a picture to the run\n Then the picture appears at the end of the run\n And the document contains the inline p... | user_story | [
{
"declaration": "(property getter) def inline_shapes(self):",
"key": [
"docx.document.Document",
"inline_shapes"
]
},
{
"declaration": "(property getter) def part(self) -> DocumentPart:",
"key": [
"docx.document.Document",
"part"
]
},
{
"declaration": "(p... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/shape.py",
"features/steps/text.py"
] |
python-docx/features/run-char-style.feature:18 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-char-style.feature",
"title": "Each run has a read/write style",
"narrative": " In order to use the stylesheet capability built into Word\n As a developer using python-docx\n I need the ability to get and set the character style of a run",
"background": null
} | {
"title": "Set the style of a run",
"line": 18,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Set the style of a run\n Given a run having <style> style\n When I assign <value> to run.style\n Then run.style is styles['<style-name>']\n\n Examples: Character style transitions\n ... | user_story | [
{
"declaration": "(property getter) def styles(self):",
"key": [
"docx.document.Document",
"styles"
]
},
{
"declaration": "def __eq__(self, other: object):",
"key": [
"docx.shared.ElementProxy",
"__eq__"
]
},
{
"declaration": "def __getitem__(self, key: st... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-char-style.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-char-style.feature",
"title": "Each run has a read/write style",
"narrative": " In order to use the stylesheet capability built into Word\n As a developer using python-docx\n I need the ability to get and set the character style of a run",
"background": null
} | {
"title": "Get the character style of a run",
"line": 7,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Get the character style of a run\n Given a run having <style> style\n Then run.style is styles['<value>']\n\n Examples: Character styles\n | style | value ... | user_story | [
{
"declaration": "(property getter) def styles(self):",
"key": [
"docx.document.Document",
"styles"
]
},
{
"declaration": "def __eq__(self, other: object):",
"key": [
"docx.shared.ElementProxy",
"__eq__"
]
},
{
"declaration": "def __getitem__(self, key: st... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-clear-run.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-clear-run.feature",
"title": "Remove the content of a run",
"narrative": " In order to edit the content of a run while preserving its formatting\n As a developer using python-docx\n I need a way to clear the content of a run",
"background": null
} | {
"title": "Clear run content",
"line": 7,
"kind": "scenario",
"tags": [],
"gherkin": " Scenario: Clear run content\n Given a run having known text and formatting\n When I clear the run\n Then the run contains no text\n But the run formatting is preserved"
} | user_story | [
{
"declaration": "(property getter) def bold(self) -> bool | None:",
"key": [
"docx.text.run.Run",
"bold"
]
},
{
"declaration": "def clear(self):",
"key": [
"docx.text.run.Run",
"clear"
]
},
{
"declaration": "(property getter) def italic(self) -> bool | No... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-enum-props.feature:19 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-enum-props.feature",
"title": "Query or apply enumerated run property",
"narrative": " In order to query or change an enumerated font property of a word or phrase\n As a python-docx developer\n I need a way to query and set the enumerated properties on a run",
"background": null
... | {
"title": "Change underline setting for a run",
"line": 19,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Change underline setting for a run\n Given a run having <underline-type> underline\n When I set the run underline to <new-underline-value>\n Then the run underline property va... | user_story | [
{
"declaration": "(property getter) def underline(self) -> bool | WD_UNDERLINE | None:",
"key": [
"docx.text.run.Run",
"underline"
]
},
{
"declaration": "(property setter) def underline(self, value: bool | WD_UNDERLINE | None):",
"key": [
"docx.text.run.Run",
"underli... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/run-enum-props.feature:7 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/run-enum-props.feature",
"title": "Query or apply enumerated run property",
"narrative": " In order to query or change an enumerated font property of a word or phrase\n As a python-docx developer\n I need a way to query and set the enumerated properties on a run",
"background": null
... | {
"title": "Get underline value of a run",
"line": 7,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Get underline value of a run\n Given a run having <underline-type> underline\n Then the run underline property value is <underline-value>\n\n Examples: underline property values\n ... | user_story | [
{
"declaration": "(property getter) def underline(self) -> bool | WD_UNDERLINE | None:",
"key": [
"docx.text.run.Run",
"underline"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/text.py"
] |
python-docx/features/sct-section.feature:104 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/sct-section.feature",
"title": "Access and change section properties",
"narrative": " In order to discover and modify document section behaviors\n As a developer using python-docx\n I need a way to get and set the properties of a section",
"background": null
} | {
"title": "Get section orientation",
"line": 104,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Get section orientation\n Given a section known to have <orientation> orientation\n Then the reported page orientation is <reported-orientation>\n\n Examples: Section page orientations\n... | user_story | [
{
"declaration": "(property getter) def orientation(self) -> WD_ORIENTATION:",
"key": [
"docx.section.Section",
"orientation"
]
}
] | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/section.py"
] |
python-docx/features/sct-section.feature:114 | python-docx | python | behave | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | https://github.com/python-openxml/python-docx | e45454602b53e8e572b179ccf1c91093ec9f4ed7 | {
"file_path": "features/sct-section.feature",
"title": "Access and change section properties",
"narrative": " In order to discover and modify document section behaviors\n As a developer using python-docx\n I need a way to get and set the properties of a section",
"background": null
} | {
"title": "Set section orientation",
"line": 114,
"kind": "outline",
"tags": [],
"gherkin": " Scenario Outline: Set section orientation\n Given a section known to have <initial-orientation> orientation\n When I set the section orientation to <new-orientation>\n Then the reported page orientation ... | user_story | [
{
"declaration": "(property getter) def orientation(self) -> WD_ORIENTATION:",
"key": [
"docx.section.Section",
"orientation"
]
},
{
"declaration": "(property setter) def orientation(self, value: WD_ORIENTATION | None):",
"key": [
"docx.section.Section",
"orientation.... | null | system | PY-FACADE | true | [
"features/steps/helpers.py",
"features/steps/section.py"
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.