Merge pull request #4 from yechielb2000/fix/codacy-remaining-issues

Fix ADF duplication, docstring sections, and simplify test imports

Author: yechielb2000

atlassian/models/jira/adf.py

@@ -82,7 +82,7 @@ def heading(self, text: str, level: int = 1) -> ADFBuilder:
         )
         return self
 
-    def bullet_list(self, items: list[str]) -> ADFBuilder:
+    def _list_node(self, list_type: str, items: list[str]) -> ADFBuilder:
         list_items = [
             {
                 "type": "listItem",
@@ -95,24 +95,14 @@ def bullet_list(self, items: list[str]) -> ADFBuilder:
             }
             for item in items
         ]
-        self._content.append({"type": "bulletList", "content": list_items})
+        self._content.append({"type": list_type, "content": list_items})
         return self
 
+    def bullet_list(self, items: list[str]) -> ADFBuilder:
+        return self._list_node("bulletList", items)
+
     def ordered_list(self, items: list[str]) -> ADFBuilder:
-        list_items = [
-            {
-                "type": "listItem",
-                "content": [
-                    {
-                        "type": "paragraph",
-                        "content": [{"type": "text", "text": item}],
-                    }
-                ],
-            }
-            for item in items
-        ]
-        self._content.append({"type": "orderedList", "content": list_items})
-        return self
+        return self._list_node("orderedList", items)
 
     def code_block(self, code: str, language: Optional[str] = None) -> ADFBuilder:
         node: dict[str, Any] = {

atlassian/models/jira/comment.py

@@ -41,7 +41,8 @@ def __post_init__(self) -> None:
     def as_args(self) -> dict[str, Any]:
         """Return keyword arguments for Jira.issue_add_comment().
 
-        Usage:
+        Usage::
+
             c = Comment("Fixed in PR #42", visibility=Visibility("role", "Developers"))
             jira.issue_add_comment("PLAT-123", **c.as_args())
         """

atlassian/models/jira/transition.py

@@ -29,7 +29,8 @@ def __post_init__(self) -> None:
     def as_args(self) -> dict[str, Any]:
         """Return keyword arguments for Jira.set_issue_status().
 
-        Usage:
+        Usage::
+
             t = Transition("PLAT-123", "Done", resolution="Fixed")
             jira.set_issue_status(**t.as_args())
         """

atlassian/models/jira/update.py

@@ -26,7 +26,8 @@ class UpdateBuilder:  # pylint: disable=too-many-public-methods
     Produces the dict format expected by Jira.issue_update() and
     Jira.update_issue_field().
 
-    Example:
+    Example::
+
         payload = (
             UpdateBuilder("PLAT-123")
             .set_summary("New title")

tests/test_jira_models.py

@@ -5,45 +5,50 @@
 
 import pytest
 
-from atlassian.models.jira.adf import ADFBuilder, MentionNode, TextNode
-from atlassian.models.jira.builders import (
-    EpicBuilder,
-    IssueBuilder,
-    SubTaskBuilder,
-    bug,
-    epic,
-    story,
-    subtask,
-    task,
-)
-from atlassian.models.jira.comment import Comment, Visibility
-from atlassian.models.jira.fields import (
+from atlassian.models.jira import (
+    ADFBuilder,
+    Bug,
+    Comment,
     Component,
     CustomField,
+    Epic,
+    EpicBuilder,
+    FieldMapping,
+    IssueBuilder,
     IssueFields,
     IssueLink,
     IssueType,
+    JiraIssue,
+    MentionNode,
     Parent,
     Priority,
     PriorityLevel,
     Project,
-    User,
-    Version,
-)
-from atlassian.models.jira.issues import (
-    Bug,
-    Epic,
-    JiraIssue,
     Story,
     SubTask,
+    SubTaskBuilder,
     Task,
+    TextNode,
+    Transition,
+    TransitionBuilder,
+    UpdateBuilder,
+    UpdatePayload,
+    User,
+    Version,
+    Visibility,
+    bug,
+    bulk_serialize,
+    epic,
     get_issue_type_registry,
     issue_type_for,
+    serialize,
+    story,
+    subtask,
+    task,
+    to_fields_dict,
+    validate,
+    validate_or_raise,
 )
-from atlassian.models.jira.serializer import FieldMapping, bulk_serialize, serialize, to_fields_dict
-from atlassian.models.jira.transition import Transition, TransitionBuilder
-from atlassian.models.jira.update import UpdateBuilder, UpdatePayload
-from atlassian.models.jira.validation import validate, validate_or_raise
 
 
 def test_project_key_only_to_dict():