lint/test/doc fixes

Author: avendesora

.pre-commit-config.yaml

@@ -37,15 +37,11 @@ repos:
   rev: v1.18.2
   hooks:
   - id: mypy
-    args: ["--config-file", "pyproject.toml", "--ignore-missing-imports"]
-    #args: [--strict, --ignore-missing-imports]
 - repo: https://github.com/sourcery-ai/sourcery
   rev: v1.40.1b10
   hooks:
   - id: sourcery
-    # The best way to use Sourcery in a pre-commit hook:
-    # * review only changed lines:
-    # * omit the summary
     args: [--diff=git diff HEAD, --no-summary]
 
-exclude: pythonbible/bible/.*/.*\.py$
+# The versions files are huge and generated automatically.
+exclude: pythonbible/bible/versions/.*\.py$

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.15.0] - 2025-11-11
+
 ### Added
 
 - Added several new English version/translation Bibles:
@@ -39,12 +41,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Modified the header image url to be an absolute url so that it hopefully shows up in PyPI correctly.
 - **BREAKING CHANGE**: Modified the NormalizedReference class to allow start chapter, start verse, end chapter, and end verse to be None.
   - The parser has also been updated to set those values to None unless they are explicitly set in the reference string. As we added more version/translation Bible texts, we realized the differences in chapter and verse numbers between versions/translations was much greater than initially assumed. This change allows for more flexibility in handling those differences.
   - The formatter has also been updated to get the appropriate start chapter, start verse, end chapter, and end verse at format time rather than parse time.
 
-## [0.14.0] - 2024-06-10
+## [0.14.0] - 2025-11-09
 
 ### Added
 
@@ -191,7 +192,8 @@ The goal of this release was to address [Issue #90], and to make things related
 
 ## [0.0.1] - 2020-10-08
 
-[unreleased]: https://github.com/avendesora/pythonbible/compare/v0.14.0...HEAD
+[unreleased]: https://github.com/avendesora/pythonbible/compare/v0.15.0...HEAD
+[0.15.0]: https://github.com/avendesora/pythonbible/compare/v0.14.0...v0.15.0
 [0.14.0]: https://github.com/avendesora/pythonbible/compare/v0.13.1...v0.14.0
 [0.13.1]: https://github.com/avendesora/pythonbible/compare/v0.13.0...v0.13.1
 [0.13.0]: https://github.com/avendesora/pythonbible/compare/v0.12.0...v0.13.0

docs/source/advanced_usage.rst

@@ -36,7 +36,7 @@ Example: Obadiah 1 vs Genesis 1
         start_verse=1,
         end_chapter=1,
         end_verse=1,
-        end_book=None
+        end_book=<Book.OBADIAH: 31>
     )
 
 If a reference like this was found for a non single chapter book, the number would be assumed to be a chapter number rather than a verse number.
@@ -56,7 +56,7 @@ If a reference like this was found for a non single chapter book, the number wou
         start_verse=1,
         end_chapter=1,
         end_verse=31,
-        end_book=None
+        end_book=<Book.GENESIS: 1>
     )
 
 Rather than being interpreted as Genesis 1:1, this would be interpreted as Genesis 1:1-31.
@@ -81,7 +81,7 @@ Example: Philemon 3-6 vs Genesis 3-6
         start_verse=3,
         end_chapter=1,
         end_verse=6,
-        end_book=None
+        end_book=<Book.PHILEMON: 57>
     )
 
 This is interpreted as Philemon 1:3-6. If a similar reference were encountered for a non single chapter book, both numbers would be assumed to be chapter numbers rather than verse numbers.
@@ -100,10 +100,10 @@ This is interpreted as Philemon 1:3-6. If a similar reference were encountered f
     NormalizedReference(
         book=<Book.GENESIS: 1>,
         start_chapter=3,
-        start_verse=1,
+        start_verse=None,
         end_chapter=6,
-        end_verse=22,
-        end_book=None
+        end_verse=None,
+        end_book=<Book.GENESIS: 1>
     )
 
 Rather than being interpreted as Genesis 1:3-6, this would be interpreted as Genesis 3:1-6:22.
@@ -205,7 +205,7 @@ For example, "Genesis - Deuteronomy" vs "Genesis;Exodus;Numbers;Leviticus;Deuter
     :execution-count: 1
 
     [
-        NormalizedReference(book=<Book.GENESIS: 1>, start_chapter=1, start_verse=1, end_chapter=34, end_verse=12, end_book=<Book.DEUTERONOMY: 5>),
+        NormalizedReference(book=<Book.GENESIS: 1>, start_chapter=None, start_verse=None, end_chapter=None, end_verse=None, end_book=<Book.DEUTERONOMY: 5>),
     ]
 
 If rather than using the range, the text specified each book of the Bible separated by a comma or semi-colon (or just about anything), then the result would be a list of five normalized references, one for each of the five books referenced.
@@ -219,11 +219,11 @@ If rather than using the range, the text specified each book of the Bible separa
     :execution-count: 2
 
     [
-        NormalizedReference(book=<Book.GENESIS: 1>, start_chapter=1, start_verse=1, end_chapter=50, end_verse=26, end_book=None),
-        NormalizedReference(book=<Book.EXODUS: 2>, start_chapter=1, start_verse=1, end_chapter=40, end_verse=38, end_book=None),
-        NormalizedReference(book=<Book.LEVITICUS: 3>, start_chapter=1, start_verse=1, end_chapter=27, end_verse=34, end_book=None),
-        NormalizedReference(book=<Book.NUMBERS: 4>, start_chapter=1, start_verse=1, end_chapter=36, end_verse=13, end_book=None),
-        NormalizedReference(book=<Book.DEUTERONOMY: 5>, start_chapter=1, start_verse=1, end_chapter=34, end_verse=12, end_book=None),
+        NormalizedReference(book=<Book.GENESIS: 1>, start_chapter=None, start_verse=None, end_chapter=None, end_verse=None, end_book=<Book.GENESIS: 1>),
+        NormalizedReference(book=<Book.EXODUS: 2>, start_chapter=None, start_verse=None, end_chapter=None, end_verse=None, end_book=<Book.EXODUS: 2>),
+        NormalizedReference(book=<Book.LEVITICUS: 3>, start_chapter=None, start_verse=None, end_chapter=None, end_verse=None, end_book=<Book.LEVITICUS: 3>),
+        NormalizedReference(book=<Book.NUMBERS: 4>, start_chapter=None, start_verse=None, end_chapter=None, end_verse=None, end_book=<Book.NUMBERS: 4>),
+        NormalizedReference(book=<Book.DEUTERONOMY: 5>, start_chapter=None, start_verse=None, end_chapter=None, end_verse=None, end_book=<Book.DEUTERONOMY: 5>)
     ]
 
 That list can optionally be optimized by converting it to verse ids and then back into references if so desired.

docs/source/basic_usage.rst

@@ -26,8 +26,8 @@ For example, given the text "The parable of the lost sheep is told in Matthew 18
     :execution-count: 1
 
     [
-        NormalizedReference(book=<Book.MATTHEW: 40>, start_chapter=18, start_verse=12, end_chapter=18, end_verse=14, end_book=None),
-        NormalizedReference(book=<Book.LUKE: 42>, start_chapter=15, start_verse=3, end_chapter=15, end_verse=7, end_book=None)
+        NormalizedReference(book=<Book.MATTHEW: 40>, start_chapter=18, start_verse=12, end_chapter=18, end_verse=14, end_book=<Book.MATTHEW: 40>),
+        NormalizedReference(book=<Book.LUKE: 42>, start_chapter=15, start_verse=3, end_chapter=15, end_verse=7, end_book=<Book.LUKE: 42>)
     ]
 
 Converting References to Verse IDs
@@ -62,7 +62,7 @@ The conversion functionality would return the following tuple of verse id intege
 .. output-cell:: python
     :execution-count: 1
 
-    [1001001, 1001002, 1001003, 1001004]
+    (1001001, 1001002, 1001003, 1001004)
 
 Converting a List of References to a List of Verse IDs
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -106,8 +106,8 @@ The conversion functionality would return the following list of normalized scrip
     :execution-count: 1
 
     [
-        NormalizedReference(book=<Book.MATTHEW: 40>, start_chapter=18, start_verse=12, end_chapter=18, end_verse=14. end_book=None),
-        NormalizedReference(book=<Book.LUKE: 42>, start_chapter=15, start_verse=3, end_chapter=15, end_verse=7, end_book=None),
+        NormalizedReference(book=<Book.MATTHEW: 40>, start_chapter=18, start_verse=12, end_chapter=18, end_verse=14, end_book=<Book.MATTHEW: 40>),
+        NormalizedReference(book=<Book.LUKE: 42>, start_chapter=15, start_verse=3, end_chapter=15, end_verse=7, end_book=<Book.LUKE: 42>)
     ]
 
 Formatting Scripture References

docs/source/conf.py

@@ -23,7 +23,7 @@
 author = "Nathan Patton"
 
 # The full version, including alpha/beta/rc tags
-release = "0.14.0"
+release = "0.15.0"
 
 
 # -- General configuration ---------------------------------------------------

pyproject.toml

@@ -11,7 +11,7 @@ module-name = "pythonbible"
 
 [project]
 name = "pythonbible"
-version = "0.14.0"
+version = "0.15.0"
 description-file = "README.md"
 requires-python = ">=3.10"
 authors = [
@@ -117,24 +117,16 @@ ignore = [
 [tool.ruff.lint.per-file-ignores]
 "docs/source/_static/pythonbible-book-groups.ipynb" = ["E501", "T201"]
 "docs/source/conf.py" = ["A001", "E501"]
-"pythonbible/__init__.py" = ["F401"]
-"pythonbible/bible/bible.py" = ["PLR0913", "FBT"]
-"pythonbible/books.py" = ["ARG003", "ARG004", "PYI034"]
-"pythonbible/book_groups.py" = ["ARG003", "ARG004", "PYI034"]
-"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" = ["A005", "ANN401", "F841", "FBT", "PLR0911"]  # TODO - remove F841
-"pythonbible/parser.py" = ["A005", "PLR2004"]
+"pythonbible/bible/bible.py" = ["PLR0913", "FBT001", "FBT002"]
+"pythonbible/books.py" = ["ARG004", "PYI034"]
+"pythonbible/book_groups.py" = ["ARG004", "PYI034"]
+"pythonbible/formatter.py" = ["ANN401", "FBT001", "FBT002", "PLR0911"]
+"pythonbible/parser.py" = ["PLR2004"]
 "pythonbible/roman_numeral_util.py" = ["E741"]
-"pythonbible/versions.py" = ["ARG003", "ARG004", "PYI034"]
-"tests/*.py" = ["D100", "D103", "D104", "FBT003", "PLR2004", "S101", "TRY301"]
-"tests/conftest.py" = ["E501", "RUF"]
-"tests/errors_test.py" = ["PT017"]
+"pythonbible/versions.py" = ["ARG004", "PYI034"]
+"tests/*.py" = ["FBT003", "PLR2004", "S101", "TRY301"]
+"tests/docs/advanced_usage_test.py" = ["FBT001"]
+"tests/formatter/missing_file_handling_test.py" = ["SLF001"]
 
 [tool.ruff.lint.isort]
 force-single-line = true
-
-[tool.mypy]
-exclude = ["pythonbible/bible/asv/*", "pythonbible/bible/kjv/*", ".*_test.py"]

pythonbible/__init__.py

@@ -8,7 +8,7 @@
 
 from __future__ import annotations
 
-__version__ = "0.14.0"
+__version__ = "0.15.0"
 
 from .bible import add_bible
 from .bible import get_bible
@@ -49,3 +49,89 @@
 from .verses import get_verse_id
 from .verses import get_verse_number
 from .versions import Version
+
+__all__ = [
+    "BOOK_GROUPS",
+    "Bible",
+    "Book",
+    "BookGroup",
+    "InvalidBibleParserError",
+    "InvalidBookError",
+    "InvalidChapterError",
+    "InvalidVerseError",
+    "MissingBookFileError",
+    "MissingVerseFileError",
+    "NormalizedReference",
+    "Version",
+    "VersionMissingVerseError",
+    "__version__",
+    "add_bible",
+    "convert_reference_to_verse_ids",
+    "convert_references_to_verse_ids",
+    "convert_verse_ids_to_references",
+    "count_books",
+    "count_chapters",
+    "count_verses",
+    "format_scripture_references",
+    "format_scripture_text",
+    "format_single_reference",
+    "get_bible",
+    "get_book_chapter_verse",
+    "get_book_number",
+    "get_chapter_number",
+    "get_number_of_chapters",
+    "get_number_of_verses",
+    "get_references",
+    "get_verse_id",
+    "get_verse_number",
+    "get_verse_text",
+    "is_valid_book",
+    "is_valid_chapter",
+    "is_valid_reference",
+    "is_valid_verse",
+    "is_valid_verse_id",
+    "normalize_reference",
+]
+# Reference the imported names so ruff/auto-fixes do not remove them as "unused".
+_ = (
+    add_bible,
+    get_bible,
+    Bible,
+    VersionMissingVerseError,
+    BOOK_GROUPS,
+    BookGroup,
+    Book,
+    convert_reference_to_verse_ids,
+    convert_references_to_verse_ids,
+    convert_verse_ids_to_references,
+    count_books,
+    count_chapters,
+    count_verses,
+    InvalidBibleParserError,
+    InvalidBookError,
+    InvalidChapterError,
+    InvalidVerseError,
+    MissingBookFileError,
+    MissingVerseFileError,
+    format_scripture_references,
+    format_scripture_text,
+    format_single_reference,
+    get_verse_text,
+    NormalizedReference,
+    get_references,
+    normalize_reference,
+    is_valid_book,
+    is_valid_chapter,
+    is_valid_reference,
+    is_valid_verse,
+    is_valid_verse_id,
+    get_book_chapter_verse,
+    get_book_number,
+    get_chapter_number,
+    get_number_of_chapters,
+    get_number_of_verses,
+    get_verse_id,
+    get_verse_number,
+    Version,
+    __version__,
+)

pythonbible/formatter.py

@@ -410,6 +410,9 @@ def _does_reference_include_all_verses_in_end_book(
     reference: NormalizedReference,
     **kwargs: Any,
 ) -> bool:
+    if reference.start_chapter is None and reference.end_chapter is None:
+        return True
+
     end_book: Book = reference.end_book or reference.book
     max_chapters = _get_number_of_chapters(end_book, **kwargs)
 
@@ -434,7 +437,6 @@ def format_scripture_text(verse_ids: list[int], **kwargs: Any) -> str:
     one_verse_per_paragraph: bool = kwargs.get("one_verse_per_paragraph", False)
     full_title: bool = kwargs.get("full_title", False)
     format_type: str = kwargs.get("format_type", "html")
-    include_books: bool = kwargs.get("include_books", True)
     include_verse_numbers: bool = kwargs.get("include_verse_numbers", True)
     version: Version = kwargs.get("version", DEFAULT_VERSION)
 

tests/bible_test.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import NoReturn
+
 import pytest
 
 import pythonbible as bible
@@ -91,3 +93,59 @@ def test_get_long_title_init_version() -> None:
 
     # Then the version is initialized and the long title is returned
     assert long_title == book.title
+
+
+def test_get_bible_import_failure_raises_missing_verse_file_error() -> None:
+    # Choose a version that has files on disk but ensure it's not cached in BIBLES
+    version = bible.Version.KING_JAMES
+
+    # Remove any existing cached bible for this version so the code will attempt to
+    # import
+    bible.bible.BIBLES.pop(version, None)
+
+    # Request a bible type that does not exist to force ModuleNotFoundError
+    # in import_module
+    with pytest.raises(pythonbible.errors.MissingVerseFileError):
+        bible.get_bible(version, "this_bible_type_does_not_exist")
+
+
+def test_get_bible_import_module_raises_missing_verse_file() -> None:
+    version = bible.Version.KING_JAMES
+    # Ensure no cached entry so get_bible will attempt to import
+    bible.bible.BIBLES.pop(version, None)
+
+    # Now calling get_bible should run the try import_module and hit the except,
+    # which should raise MissingVerseFileError derived from ModuleNotFoundError.
+    with pytest.raises(pythonbible.errors.MissingVerseFileError):
+        bible.get_bible(version, "any_type")
+
+
+def test_get_bible_import_module_raises_module_not_found_in_module(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    # Monkeypatch the import_module function used inside pythonbible.bible.get_bible
+    version = bible.Version.KING_JAMES
+    bible.bible.BIBLES.pop(version, None)
+
+    def raise_module_not_found(name: str, package: str | None = None) -> NoReturn:
+        error_message = f"No module named '{name}' in package '{package}'"
+        raise ModuleNotFoundError(error_message)
+
+    monkeypatch.setattr(bible.bible, "import_module", raise_module_not_found)
+
+    with pytest.raises(pythonbible.errors.MissingVerseFileError):
+        bible.get_bible(version, "any_type")
+
+
+def test_get_bible_with_missing_version_files_raises_missing_verse_file_error() -> None:
+    # Create a minimal version-like object with a value for which no folder exists
+    class DummyVersion:
+        value = "this_version_folder_does_not_exist"
+
+    # Ensure no cached entry exists for this dummy key
+    bible.bible.BIBLES.pop(DummyVersion, None)  # type: ignore[arg-type,call-overload]
+
+    # Calling get_bible should check _do_version_files_exist and raise
+    # MissingVerseFileError
+    with pytest.raises(pythonbible.errors.MissingVerseFileError):
+        bible.get_bible(DummyVersion, "plain_text")  # type: ignore[arg-type]