use RUFF for static code analysis (possibly to eventually replace flake8) (#92)

* use RUFF for static code analysis (possibly to eventually replace flake8)

* oops...

* ignore if TYPE_CHECKING blocks for test coverage

* version 0.9.1

Author: avendesora

.coveragerc

@@ -0,0 +1,4 @@
+[report]
+exclude_lines =
+    pragma: no cover
+    if TYPE_CHECKING:

.pre-commit-config.yaml

@@ -8,6 +8,11 @@ repos:
       - id: debug-statements
       - id: name-tests-test
       - id: requirements-txt-fixer
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.0.265'
+    hooks:
+      - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
@@ -50,10 +55,12 @@ exclude: |
       pythonbible/bible/asv/plain_text.py|
       pythonbible/bible/asv/plain_text_notes.py|
       pythonbible/bible/asv/plain_text_readers.py|
+      pythonbible/bible/asv/titles.py|
       pythonbible/bible/kjv/html.py|
       pythonbible/bible/kjv/html_notes.py|
       pythonbible/bible/kjv/html_readers.py|
       pythonbible/bible/kjv/plain_text.py|
       pythonbible/bible/kjv/plain_text_notes.py|
-      pythonbible/bible/kjv/plain_text_readers.py
+      pythonbible/bible/kjv/plain_text_readers.py|
+      pythonbible/bible/kjv/titles.py
   )$

docs/source/__init__.py

@@ -11,9 +11,6 @@
 # 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 os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
 
 
 # -- Project information -----------------------------------------------------
@@ -23,7 +20,7 @@
 author = "Nathan Patton"
 
 # The full version, including alpha/beta/rc tags
-release = "0.9"
+release = "0.9.1"
 
 
 # -- General configuration ---------------------------------------------------

docs/source/conf.py

@@ -49,3 +49,80 @@ dev = [
 profile = "black"
 add_imports = "from __future__ import annotations"
 force_single_line = true
+
+[tool.ruff]
+select = [
+    "A",
+    "ANN",
+    "ARG",
+    "B",
+    "BLE",
+    "COM",
+    "C4",
+    "C90",
+    "D",
+    "DTZ",
+    "E",
+    "EM",
+    "ERA",
+    "EXE",
+    "F",
+    "FBT",
+    "G",
+    "I",
+    "ICN",
+    "INP",
+    "ISC",
+    "N",
+    "NPY",
+    "PD",
+    "PGH",
+    "PIE",
+    "PL",
+    "PT",
+    "PTH",
+    "PYI",
+    "Q",
+    "RET",
+    "RSE",
+    "RUF",
+    "S",
+    "SIM",
+    "SLF",
+    "TCH",
+    "TID",
+    "TRY",
+    "T10",
+    "T20",
+    "W",
+]
+ignore = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D205",
+    "D203",
+    "D213",
+]
+fix = true
+
+[tool.ruff.per-file-ignores]
+"docs/source/conf.py" = ["A001", "E501"]
+"pythonbible/__init__.py" = ["F401"]
+"pythonbible/bible/bible.py" = ["PLR0913", "FBT"]
+"pythonbible/counters/book_counter.py" = ["TCH001"]
+"pythonbible/counters/chapter_counter.py" = ["TCH001"]
+"pythonbible/counters/verse_counter.py" = ["TCH001"]
+"pythonbible/errors.py" = ["PLR0913"]
+"pythonbible/formatter.py" = ["ANN401", "FBT", "PLR0911"]
+"pythonbible/parser.py" = ["PLR2004"]
+"pythonbible/regular_expressions.py" = ["ISC001"]
+"pythonbible/roman_numeral_util.py" = ["E741"]
+"tests/*.py" = ["D100", "D103", "D104", "PLR2004", "S101", "TRY301"]
+"tests/conftest.py" = ["E501", "RUF"]
+"tests/errors_test.py" = ["PT017"]
+
+[tool.ruff.isort]
+force-single-line = true

pyproject.toml

@@ -1,5 +1,4 @@
-"""
-The pythonbible library.
+"""The pythonbible library.
 
 pythonbible includes features for parsing texts for scripture references,
 converting references into integer verse ids for efficient use/storage,
@@ -9,7 +8,7 @@
 
 from __future__ import annotations
 
-__version__ = "0.9"
+__version__ = "0.9.1"
 
 from .bible.bible import Bible
 from .book_groups import BOOK_GROUPS

pythonbible/__init__.py

@@ -2,15 +2,17 @@
 from __future__ import annotations
 
 from functools import lru_cache
+from typing import TYPE_CHECKING
 
 from pythonbible.errors import InvalidVerseError
 from pythonbible.validator import is_valid_verse_id
-from pythonbible.versions import Version
+
+if TYPE_CHECKING:
+    from pythonbible.versions import Version
 
 
 class Bible:
-    """
-    The Bible class.
+    """The Bible class.
 
     The Bible class contains the scripture content for a version and format along with
     the functionality necessary to get the scripture content for a verse or range of
@@ -25,26 +27,34 @@ def __init__(
         verse_end_indices: dict[int, int],
         is_html: bool = False,
     ) -> None:
+        """Initialize a Bible object.
+
+        :param version: The version of the Bible.
+        :param scripture_content: The scripture content for the Bible.
+        :param verse_start_indices: The start indices for each verse.
+        :param verse_end_indices: The end indices for each verse.
+        """
         self.version: Version = version
         self.scripture_content: str = scripture_content
         self.verse_start_indices: dict[int, int] = verse_start_indices
         self.verse_end_indices: dict[int, int] = verse_end_indices
         self.is_html: bool = is_html
 
-    @lru_cache()
     def get_scripture(
         self: Bible,
         start_verse_id: int,
         end_verse_id: int | None = None,
     ) -> str:
         if not is_valid_verse_id(start_verse_id):
+            msg = f"start verse id ({start_verse_id}) is not a valid verse id."
             raise InvalidVerseError(
-                f"start verse id ({start_verse_id}) is not a valid verse id.",
+                msg,
             )
 
         if end_verse_id and not is_valid_verse_id(end_verse_id):
+            msg = f"end verse id ({end_verse_id}) is not a valid verse id."
             raise InvalidVerseError(
-                f"end verse id ({end_verse_id}) is not a valid verse id.",
+                msg,
             )
 
         end_verse_id = end_verse_id or start_verse_id

pythonbible/bible/bible.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 import pythonbible.bible.asv.html as asv_html
 import pythonbible.bible.asv.html_notes as asv_html_notes
 import pythonbible.bible.asv.html_readers as asv_html_readers
@@ -12,10 +14,12 @@
 import pythonbible.bible.kjv.plain_text as kjv_plain_text
 import pythonbible.bible.kjv.plain_text_notes as kjv_plain_text_notes
 import pythonbible.bible.kjv.plain_text_readers as kjv_plain_text_readers
-from pythonbible.bible.bible import Bible
 from pythonbible.errors import MissingVerseFileError
 from pythonbible.versions import Version
 
+if TYPE_CHECKING:
+    from pythonbible.bible.bible import Bible
+
 BIBLES = {
     Version.AMERICAN_STANDARD: {
         "html": asv_html.bible,
@@ -37,8 +41,7 @@
 
 
 def get_bible(version: Version, bible_type: str) -> Bible:
-    """
-    Return the Bible for the given version and format.
+    """Return the Bible for the given version and format.
 
     :param version: The version of the Bible
     :type version: Version
@@ -50,4 +53,4 @@ def get_bible(version: Version, bible_type: str) -> Bible:
     try:
         return BIBLES[version][bible_type]
     except KeyError as e:
-        raise MissingVerseFileError() from e
+        raise MissingVerseFileError from e

pythonbible/bible/bibles.py

@@ -8,8 +8,7 @@
 
 
 class BookGroup(Enum):
-    """
-    BookGroup is an ``Enum`` containing the default Bible book groupings.
+    """BookGroup is an ``Enum`` containing the default Bible book groupings.
 
     :param name: the unique text identifier of the book group
     :type name: str

pythonbible/book_groups.py

@@ -5,8 +5,7 @@
 
 
 class Book(IntEnum):
-    """
-    Book is an IntEnum that contains all of the books of the Bible.
+    """Book is an IntEnum that contains all of the books of the Bible.
 
     :param name: the unique text identifier of the book
     :type name: str