[pre-commit.ci] pre-commit autoupdate (#97)

pre-commit-ci[bot] · avendesora · web-flow · commit 7ad11e76c153 · 2023-06-13T21:04:59.000-05:00
* [pre-commit.ci] pre-commit autoupdate updates: - [github.com/charliermarsh/ruff-pre-commit: v0.0.269 → v0.0.272](astral-sh/ruff-pre-commit@v0.0.269...v0.0.272) * static code analysis fixes --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Nathan Patton <npatton@gmail.com>
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -9,7 +9,7 @@ repos:
       - id: name-tests-test
       - id: requirements-txt-fixer
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.269'
+    rev: 'v0.0.272'
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix ]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Updated README to more accurately describe current OSIS parser and Bible text formatting functionality
+- Minor code quality improvements based on static code analysis
 
 ## [0.10.0]
 
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -10,7 +10,6 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 import pathlib
 import sys
 
diff --git a/pythonbible/bible/bibles.py b/pythonbible/bible/bibles.py
@@ -52,5 +52,5 @@ def get_bible(version: Version, bible_type: str) -> Bible:
     """
     try:
         return BIBLES[version][bible_type]
-    except KeyError as e:
-        raise MissingVerseFileError from e
+    except KeyError as error:
+        raise MissingVerseFileError from error
diff --git a/pythonbible/books.py b/pythonbible/books.py
@@ -195,7 +195,7 @@ def abbreviations(self: Book) -> tuple[str, ...]:
         22,
         "Song of Songs",
         r"(Song(?: of (Solomon|Songs|Sol\.*))?)"
-        r"|Canticles|(Canticle(?: of Canticles)?)|SOS|Cant",
+        "|Canticles|(Canticle(?: of Canticles)?)|SOS|Cant",
         ("Cant", "Canticle", "Canticles", "Song", "Song of Sol", "SOS"),
     )
     ISAIAH = 23, "Isaiah", r"Isa\.*(?:iah)?", ("Isa",)
diff --git a/pythonbible/formatter.py b/pythonbible/formatter.py
@@ -351,7 +351,6 @@ def format_scripture_text(verse_ids: list[int], **kwargs: Any) -> str:
     text: str = ""
     current_book: Book | None = None
     current_chapter: int | None = None
-    previous_verse_number: int | None = None
     current_start_verse: int | None = None
     current_end_verse: int | None = None
 
@@ -360,10 +359,8 @@ def format_scripture_text(verse_ids: list[int], **kwargs: Any) -> str:
 
         if (
             one_verse_per_paragraph
-            or book != current_book
-            or chapter_number != current_chapter
-            or previous_verse_number is None
-            or verse_number != previous_verse_number + 1
+            or current_end_verse is None
+            or verse_id - current_end_verse > 1
         ):
             if current_start_verse and current_end_verse:
                 verse_text = bible.get_scripture(current_start_verse, current_end_verse)
@@ -372,7 +369,6 @@ def format_scripture_text(verse_ids: list[int], **kwargs: Any) -> str:
             current_start_verse = verse_id
 
         current_end_verse = verse_id
-        previous_verse_number = verse_number
 
         if book != current_book:
             current_book = book
diff --git a/pythonbible/normalized_reference.py b/pythonbible/normalized_reference.py
@@ -9,8 +9,9 @@
 
 @dataclass
 class NormalizedReference:
-    """NormalizedReference is a dataclass that represents a single scripture reference
-    that contains one or more consecutive verses.
+    """NormalizedReference is a dataclass that represents a single scripture reference.
+
+    The scripture reference contains one or more consecutive verses.
 
     :param book: the first book of the Bible in the reference
     :type book: Book
diff --git a/pythonbible/parser.py b/pythonbible/parser.py
@@ -25,8 +25,9 @@ def get_references(
     text: str,
     book_groups: dict[str, tuple[Book, ...]] = None,
 ) -> list[NormalizedReference]:
-    """Search the text for scripture references and return any that are found in a list
-    of normalized tuple references.
+    """Search the text for scripture references.
+
+    Return any scripture references that are found in a list of normalized references.
 
     :param text: String that may contain zero or more scripture references
     :type text: str
diff --git a/pythonbible/regular_expressions.py b/pythonbible/regular_expressions.py
@@ -7,15 +7,15 @@
 
 DIGIT: str = r"(\d{1,3})"
 SPACE: str = r"\s*"
-COLON: str = rf"{SPACE}([:.]){SPACE}"
-DASH = rf"{SPACE}-{SPACE}"
-COMMA = rf"{SPACE},{SPACE}"
+COLON: str = f"{SPACE}([:.]){SPACE}"
+DASH = f"{SPACE}-{SPACE}"
+COMMA = f"{SPACE},{SPACE}"
 
 BOOK: str = rf"\b({'|'.join(book.regular_expression for book in Book)})\b\.*"
 CHAPTER: str = DIGIT
 VERSE: str = DIGIT
 
-CHAPTER_AND_VERSE: str = rf"({CHAPTER}(?:{COLON}{VERSE})?)"
+CHAPTER_AND_VERSE: str = f"({CHAPTER}(?:{COLON}{VERSE})?)"
 
 # Possibly range regular expressions are:
 # 1. Book - Book (with optional chapter/verse)
@@ -27,15 +27,15 @@
 
 # TODO - this regex may have some false positives for ranges given the above rules.
 RANGE: str = (
-    rf"{DASH}(({BOOK}{SPACE}(?:{CHAPTER_AND_VERSE})?)|{CHAPTER_AND_VERSE}|{VERSE})"
+    f"{DASH}(({BOOK}{SPACE}(?:{CHAPTER_AND_VERSE})?)|{CHAPTER_AND_VERSE}|{VERSE})"
 )
 
-ADDITIONAL_REFERENCE: str = rf"({COMMA}({CHAPTER_AND_VERSE}(?:{RANGE})?|{VERSE}))"
+ADDITIONAL_REFERENCE: str = f"({COMMA}({CHAPTER_AND_VERSE}(?:{RANGE})?|{VERSE}))"
 FULL_CHAPTER_AND_VERSE: str = (
     f"({CHAPTER_AND_VERSE}(?:{RANGE})?({ADDITIONAL_REFERENCE})*)"
 )
-FULL_BOOK = rf"({BOOK}){SPACE}(?:{FULL_CHAPTER_AND_VERSE})?"
-CROSS_BOOK = rf"({FULL_BOOK}(?:{DASH}({FULL_BOOK}))?)"
+FULL_BOOK = f"({BOOK}){SPACE}(?:{FULL_CHAPTER_AND_VERSE})?"
+CROSS_BOOK = f"({FULL_BOOK}(?:{DASH}({FULL_BOOK}))?)"
 
 SCRIPTURE_REFERENCE_REGULAR_EXPRESSION: Pattern[str] = re.compile(
     CROSS_BOOK,
diff --git a/pythonbible/verses.py b/pythonbible/verses.py
@@ -1521,12 +1521,12 @@ def get_number_of_verses(book: Book, chapter: int) -> int:
 
     try:
         return chapter_list[chapter - 1]
-    except IndexError as e:
+    except IndexError as error:
         error_message = (
             f"{chapter} is not a valid chapter number for the book of {book.title}. "
             f"Valid chapter numbers are 1-{len(chapter_list)}."
         )
-        raise InvalidChapterError(error_message) from e
+        raise InvalidChapterError(error_message) from error
 
 
 @lru_cache()
diff --git a/setup.cfg b/setup.cfg
@@ -19,6 +19,7 @@ ignore =
     WPS305,
     WPS306,
     WPS337,
+    WPS473,
     WPS508
 
     # these should be turned back on soon
@@ -41,23 +42,26 @@ ignore =
     WPS230,
     WPS231,
     WPS326,
-    WPS352
+    WPS352,
+    WPS407,
 
 per-file-ignores =
     docs/source/conf.py:A001,E501,E800,INP001,WPS462
-    pythonbible/__init__.py:F401,WPS130,WPS201,WPS300,WPS410,WPS412
+    pythonbible/__init__.py:F401,WPS130,WPS201,WPS300,WPS410,WPS412,WS003
+    pythonbible/bible/bibles.py:WPS201,WPS301
+    pythonbible/bible/titles.py:WPS301
     pythonbible/bible/*.py:E501
-    pythonbible/book_groups.py:WPS115
-    pythonbible/books.py:WPS114,WPS115
+    pythonbible/book_groups.py:WPS110,WPS115,WPS120,WPS437
+    pythonbible/books.py:WPS110,WPS114,WPS115,WPS120,WPS226,WPS317,WPS437
     pythonbible/formatter.py:WPS118,WPS201,WPS204,WPS226,WPS336
     pythonbible/parser.py:WPS232
     pythonbible/roman_numeral_util.py:E741,WPS111,WPS121,WPS115
     pythonbible/regular_expressions.py:WPS226
-    pythonbible/versions.py:WPS114,WPS115
+    pythonbible/versions.py:WPS110,WPS114,WPS115,WPS120,WPS437
     tests/__init__.py:WPS412
-    tests/conftest.py:D100,D103,E501,WPS234,WPS432
+    tests/conftest.py:D100,D103,E501,WPS118,WPS234,WPS432
     tests/errors_test.py:PT017,S101,WPS111,WPS118,WPS204,WPS328,WPS226
-    tests/regular_expressions_test.py:PT018,S101
+    tests/regular_expressions_test.py:PT018,S101,WPS204,
     tests/*.py:D100,D103,D104,S101,WPS114,WPS118,WPS204,WPS210,WPS218,WPS226,WPS326,WPS432
 
 exclude =
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -47,7 +47,10 @@ def text_with_reference() -> str:
 
 @pytest.fixture()
 def text_with_reference_complex() -> str:
-    return "You should read Psalm 130:4,8, Jeremiah 29:32-30:10,31:12, Matthew 1:18 - 2:18, and Luke 3: 5-7."
+    return (
+        "You should read Psalm 130:4,8, Jeremiah 29:32-30:10,31:12, "
+        "Matthew 1:18 - 2:18, and Luke 3: 5-7."
+    )
 
 
 @pytest.fixture()
@@ -180,32 +183,35 @@ def formatted_reference() -> str:
 
 @pytest.fixture()
 def roman_numeral_references() -> str:
-    return "Psalm cxxx.4,8, Jeremiah xxix. 32 - xxx. 10, xxxi. 12, Matthew i. 18 - ii. 18, and Luke iii. 5-7."
+    return (
+        "Psalm cxxx.4,8, Jeremiah xxix. 32 - xxx. 10, xxxi. 12, "
+        "Matthew i. 18 - ii. 18, and Luke iii. 5-7."
+    )
 
 
 @pytest.fixture()
 def html_scripture_text() -> str:
     return (
         "<h1>Matthew</h1>\n"
         "<h2>Chapter 18</h2>\n"
-        "<p><sup>12</sup> How think ye? if a man have an hundred sheep, and one of them "
-        "be gone astray, doth he not leave the ninety and nine, and goeth into "
-        "the mountains, and seeketh that which is gone astray? <sup>13</sup> And if so be "
-        "that he find it, verily I say unto you, he rejoiceth more of that "
-        "sheep, than of the ninety and nine which went not astray. <sup>14</sup> Even so "
-        "it is not the will of your Father which is in heaven, that one of "
-        "these little ones should perish.</p>\n"
+        "<p><sup>12</sup> How think ye? if a man have an hundred sheep, and one of "
+        "them be gone astray, doth he not leave the ninety and nine, and goeth into "
+        "the mountains, and seeketh that which is gone astray? <sup>13</sup> And if so "
+        "be that he find it, verily I say unto you, he rejoiceth more of that sheep, "
+        "than of the ninety and nine which went not astray. <sup>14</sup> Even so it "
+        "is not the will of your Father which is in heaven, that one of these little "
+        "ones should perish.</p>\n"
         "<h1>Luke</h1>\n"
         "<h2>Chapter 15</h2>\n"
-        "<p><sup>3</sup> And he spake this parable unto them, saying, <sup>4</sup> What man of you, "
-        "having an hundred sheep, if he lose one of them, doth not leave the "
-        "ninety and nine in the wilderness, and go after that which is lost, "
+        "<p><sup>3</sup> And he spake this parable unto them, saying, <sup>4</sup> "
+        "What man of you, having an hundred sheep, if he lose one of them, doth not "
+        "leave the ninety and nine in the wilderness, and go after that which is lost, "
         "until he find it? <sup>5</sup> And when he hath found it, he layeth it on his "
-        "shoulders, rejoicing. <sup>6</sup> And when he cometh home, he calleth together "
-        "his friends and neighbours, saying unto them, Rejoice with me; for I "
-        "have found my sheep which was lost. <sup>7</sup> I say unto you, that likewise "
-        "joy shall be in heaven over one sinner that repenteth, more than over "
-        "ninety and nine just persons, which need no repentance.</p>\n"
+        "shoulders, rejoicing. <sup>6</sup> And when he cometh home, he calleth "
+        "together his friends and neighbours, saying unto them, Rejoice with me; for I "
+        "have found my sheep which was lost. <sup>7</sup> I say unto you, that "
+        "likewise joy shall be in heaven over one sinner that repenteth, more than "
+        "over ninety and nine just persons, which need no repentance.</p>\n"
     )
 
 
@@ -266,16 +272,17 @@ def html_scripture_text_one_verse_per_paragraph() -> str:
     return (
         "<h1>Matthew</h1>\n"
         "<h2>Chapter 18</h2>\n"
-        "<p><sup>12</sup> How think ye? if a man have an hundred sheep, and one of them "
-        "be gone astray, doth he not leave the ninety and nine, and goeth into "
+        "<p><sup>12</sup> How think ye? if a man have an hundred sheep, and one of "
+        "them be gone astray, doth he not leave the ninety and nine, and goeth into "
         "the mountains, and seeketh that which is gone astray?</p>\n"
-        "<p><sup>13</sup> And if so be that he find it, verily I say unto you, he rejoiceth "
-        "more of that sheep, than of the ninety and nine which went not astray.</p>\n"
-        "<p><sup>14</sup> Even so it is not the will of your Father which is in heaven, "
-        "that one of these little ones should perish.</p>\n"
+        "<p><sup>13</sup> And if so be that he find it, verily I say unto you, he "
+        "rejoiceth more of that sheep, than of the ninety and nine which went not "
+        "astray.</p>\n"
+        "<p><sup>14</sup> Even so it is not the will of your Father which is in "
+        "heaven, that one of these little ones should perish.</p>\n"
         "<h2>Chapter 19</h2>\n"
-        "<p><sup>1</sup> And it came to pass, that when Jesus had finished these sayings, he "
-        "departed from Galilee, and came into the coasts of Judaea beyond "
+        "<p><sup>1</sup> And it came to pass, that when Jesus had finished these "
+        "sayings, he departed from Galilee, and came into the coasts of Judaea beyond "
         "Jordan;</p>\n"
     )
 
@@ -285,30 +292,25 @@ def non_html_scripture_text_one_verse_per_paragraph() -> str:
     return (
         "Matthew\n\n"
         "Chapter 18\n\n"
-        "12. How think ye? if a man have an hundred sheep, and one of them "
-        "be gone astray, doth he not leave the ninety and nine, and goeth into "
-        "the mountains, and seeketh that which is gone astray?\n"
-        "13. And if so be "
-        "that he find it, verily I say unto you, he rejoiceth more of that "
-        "sheep, than of the ninety and nine which went not astray.\n"
-        "14. Even so "
-        "it is not the will of your Father which is in heaven, that one of "
+        "12. How think ye? if a man have an hundred sheep, and one of them be gone "
+        "astray, doth he not leave the ninety and nine, and goeth into the mountains, "
+        "and seeketh that which is gone astray?\n"
+        "13. And if so be that he find it, verily I say unto you, he rejoiceth more of "
+        "that sheep, than of the ninety and nine which went not astray.\n"
+        "14. Even so it is not the will of your Father which is in heaven, that one of "
         "these little ones should perish.\n\n\n"
         "Luke\n\n"
         "Chapter 15\n\n"
         "3. And he spake this parable unto them, saying,\n"
-        "4. What man of you, "
-        "having an hundred sheep, if he lose one of them, doth not leave the "
-        "ninety and nine in the wilderness, and go after that which is lost, "
+        "4. What man of you, having an hundred sheep, if he lose one of them, doth not "
+        "leave the ninety and nine in the wilderness, and go after that which is lost, "
         "until he find it?\n"
-        "5. And when he hath found it, he layeth it on his "
-        "shoulders, rejoicing.\n"
-        "6. And when he cometh home, he calleth together "
-        "his friends and neighbours, saying unto them, Rejoice with me; for I "
-        "have found my sheep which was lost.\n"
-        "7. I say unto you, that likewise "
-        "joy shall be in heaven over one sinner that repenteth, more than over "
-        "ninety and nine just persons, which need no repentance.\n"
+        "5. And when he hath found it, he layeth it on his shoulders, rejoicing.\n"
+        "6. And when he cometh home, he calleth together his friends and neighbours, "
+        "saying unto them, Rejoice with me; for I have found my sheep which was lost.\n"
+        "7. I say unto you, that likewise joy shall be in heaven over one sinner that "
+        "repenteth, more than over ninety and nine just persons, which need no "
+        "repentance.\n"
     )
 
 
@@ -420,7 +422,10 @@ def book_alternative_names() -> dict[bible.Book, list[str]]:
             "II Kgs.",
             "II Kings",
             "The Second Book of the Kings",
-            "The Second Book of the Kings, Commonly Called the Fourth Book of the Kings",
+            (
+                "The Second Book of the Kings, Commonly Called the Fourth Book of the "
+                "Kings"
+            ),
         ],
         bible.Book.CHRONICLES_1: [
             "1 Chr",
diff --git a/tests/regular_expressions_test.py b/tests/regular_expressions_test.py
@@ -246,11 +246,11 @@ def test_jo() -> None:
         "Jonah",
     ]
 
-    for text in test_strings:
+    for test_string in test_strings:
         # when evaluating the string to see if it matches the John regular expression
         matches: list[Match[str]] = re.findall(
             bible.Book.JOHN.regular_expression,
-            f"{text} 1:1",
+            f"{test_string} 1:1",
         )
 
         # then the matches are not found

Original file line number	Diff line number	Diff line change
`@@ -195,7 +195,7 @@ def abbreviations(self: Book) -> tuple[str, ...]:`
`195`	`195`	`22,`
`196`	`196`	`"Song of Songs",`
`197`	`197`	`r"(Song(?: of (Solomon\|Songs\|Sol\.*))?)"`
`198`		`- r"\|Canticles\|(Canticle(?: of Canticles)?)\|SOS\|Cant",`
	`198`	`+ "\|Canticles\|(Canticle(?: of Canticles)?)\|SOS\|Cant",`
`199`	`199`	`("Cant", "Canticle", "Canticles", "Song", "Song of Sol", "SOS"),`
`200`	`200`	`)`
`201`	`201`	`ISAIAH = 23, "Isaiah", r"Isa\.*(?:iah)?", ("Isa",)`