This repository was archived by the owner on Jan 1, 2026. It is now read-only.
forked from avendesora/pythonbible
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathformatter.py
More file actions
529 lines (424 loc) · 16.5 KB
/
formatter.py
File metadata and controls
529 lines (424 loc) · 16.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
from __future__ import annotations
from functools import lru_cache
from typing import TYPE_CHECKING
from typing import Any
from pythonbible import VersionMissingBookError
from pythonbible.bible import get_bible
from pythonbible.converter import convert_references_to_verse_ids
from pythonbible.converter import convert_verse_ids_to_references
from pythonbible.verses import get_book_chapter_verse
from pythonbible.verses import get_number_of_chapters
from pythonbible.verses import get_number_of_verses
from pythonbible.verses import is_single_chapter_book
from pythonbible.versions import DEFAULT_VERSION
from pythonbible.versions import Version
if TYPE_CHECKING:
from pythonbible.bible.bible import Bible
from pythonbible.books import Book
from pythonbible.normalized_reference import NormalizedReference
# TODO - handle Psalms vs Psalm appropriately
# TODO - handle single chapter books appropriately (e.g. Obadiah 1-4 rather than
# Obadiah 1:1-4)
def format_scripture_references(
references: list[NormalizedReference] | None,
bible: Bible | None = None,
**kwargs: Any,
) -> str:
"""Return a human-readable string of the given normalized scripture references.
:param references: A list of normalized scripture references
:type references: list[NormalizedReference]
:param bible: An optional Bible object to format against
:type bible: Bible | None
:param kwargs: Additional keyword arguments to pass to the formatter functions
:type kwargs: Any
:return: A human-readable string of the given normalized scripture references
:rtype: str
:raises InvalidVerseError: If a verse id in the reference is not valid
:raises VersionMissingBookError: If a book in the reference is not present in the
given Bible version
:raises VersionMissingChapterError: If a chapter in the reference is not present in
the given Bible version
:raises VersionMissingVerseError: If a verse in the reference is not present in
the given Bible version
"""
if references is None:
return ""
sorted_references: list[NormalizedReference] = references
# Only sort if there is more than one reference as it can take a long time if there
# are a lot of verses covered by the references.
if len(references) > 1:
verse_ids: list[int] = convert_references_to_verse_ids(references, bible)
verse_ids.sort()
sorted_references = convert_verse_ids_to_references(verse_ids, bible)
formatted_reference: str = ""
previous_reference: NormalizedReference | None = None
for reference in sorted_references:
previous_book: Book | None = _get_previous_book(previous_reference)
if previous_book != reference.book:
if previous_reference:
formatted_reference += ";"
formatted_reference += format_single_reference(
reference, bible=bible, **kwargs
)
previous_reference = reference
continue
if _is_reference_with_a_new_chapter(previous_reference, reference):
formatted_reference += ","
formatted_reference += format_single_reference(
reference,
include_books=False,
bible=bible,
**kwargs,
)
continue
# Reference with same book and chapter as previous reference
formatted_reference += ","
formatted_reference += format_single_reference(
reference,
include_books=False,
include_chapters=False,
bible=bible,
**kwargs,
)
previous_reference = reference
return formatted_reference
def _get_previous_book(reference: NormalizedReference | None) -> Book | None:
if reference is None:
return None
return reference.book if reference.end_book is None else reference.end_book
def _is_reference_with_a_new_chapter(
previous_reference: NormalizedReference | None,
current_reference: NormalizedReference,
) -> bool:
if (
previous_reference
and previous_reference.end_chapter != current_reference.start_chapter
):
return True
return (current_reference.end_chapter or 0) > (current_reference.start_chapter or 1)
def format_single_reference(
reference: NormalizedReference,
include_books: bool = True,
include_chapters: bool = True,
bible: Bible | None = None,
**kwargs: Any,
) -> str:
"""Return a human-readable string of the given normalized scripture reference.
:param reference: A normalized scripture reference
:type reference: NormalizedReference
:param include_books: If True includes the book title(s) in the returned reference
string, defaults to True
:type include_books: bool
:param include_chapters: If True includes the chapter number(s) in the returned
reference string, defaults to True
:type include_chapters: bool
:param bible: An optional Bible object to format against
:type bible: Bible | None
:param kwargs: Additional keyword arguments to pass to the formatter functions
:type kwargs: Any
:return: A human-readable string of the given normalized scripture reference
:rtype: str
:raises InvalidVerseError: If a verse id in the reference is not valid
:raises VersionMissingBookError: If a book in the reference is not present in the
given Bible version
:raises VersionMissingChapterError: If a chapter in the reference is not present in
the given Bible version
:raises VersionMissingVerseError: If a verse in the reference is not present in
the given Bible version
"""
full_title: bool = kwargs.get("full_title", False)
start_book: str = _get_start_book(reference, full_title, include_books, bible)
start_chapter: str = _get_start_chapter(
reference,
include_chapters,
bible=bible,
**kwargs,
)
start_verse: str = _get_start_verse(reference, bible=bible, **kwargs)
end_book: str = _get_end_book(reference, full_title, include_books, bible)
end_chapter: str = _get_end_chapter(
reference,
include_chapters,
bible=bible,
**kwargs,
)
end_verse: str = _get_end_verse(reference, bible=bible, **kwargs)
start_separator: str = " " if start_book and (start_chapter or start_verse) else ""
end_separator: str = " " if end_book and (end_chapter or end_verse) else ""
range_separator: str = ""
if end_book:
range_separator = " - "
elif end_chapter or end_verse:
range_separator = "-"
return "".join(
[
start_book,
start_separator,
start_chapter,
start_verse,
range_separator,
end_book,
end_separator,
end_chapter,
end_verse,
],
)
def _get_start_book(
reference: NormalizedReference,
full_title: bool,
include_books: bool = True,
bible: Bible | None = None,
) -> str:
return _get_book_title(reference.book, full_title, include_books, bible)
def _get_end_book(
reference: NormalizedReference,
full_title: bool,
include_books: bool = True,
bible: Bible | None = None,
) -> str:
if reference.end_book and reference.end_book != reference.book:
return _get_book_title(reference.end_book, full_title, include_books, bible)
return ""
def _get_book_title(
book: Book,
full_title: bool,
include_books: bool = True,
bible: Bible | None = None,
) -> str:
if not include_books:
return ""
if bible is None:
return book.title
title = bible.long_titles.get(book) if full_title else bible.short_titles.get(book)
if title is not None:
return title
raise VersionMissingBookError(bible.version, book)
def _get_start_chapter(
reference: NormalizedReference,
include_chapters: bool = True,
bible: Bible | None = None,
**kwargs: Any,
) -> str:
if not include_chapters:
return ""
force_include_chapters: bool = kwargs.get("always_include_chapter_numbers", False)
if (
_does_reference_include_all_verses_in_start_book(reference, bible)
and not force_include_chapters
):
return ""
if is_single_chapter_book(reference.book, bible) and not force_include_chapters:
return ""
return f"{reference.start_chapter or 1}:"
def _get_start_verse(
reference: NormalizedReference,
bible: Bible | None = None,
**kwargs: Any,
) -> str:
force_include_chapters: bool = kwargs.get("always_include_chapter_numbers", False)
if (
_does_reference_include_all_verses_in_start_book(reference, bible)
and not force_include_chapters
):
return ""
return f"{reference.start_verse or 1}"
def _get_end_chapter(
reference: NormalizedReference,
include_chapters: bool = True,
bible: Bible | None = None,
**kwargs: Any,
) -> str:
if not include_chapters:
return ""
force_include_chapters: bool = kwargs.get("always_include_chapter_numbers", False)
if reference.end_book and reference.book != reference.end_book:
if (
_does_reference_include_all_verses_in_end_book(reference, bible)
and not force_include_chapters
):
return ""
if (
is_single_chapter_book(reference.end_book, bible)
and not force_include_chapters
):
return ""
end_chapter = reference.end_chapter or get_number_of_chapters(
reference.end_book,
bible,
)
return f"{end_chapter}:"
if (
_does_reference_include_all_verses_in_start_book(reference, bible)
and not force_include_chapters
):
return ""
if is_single_chapter_book(reference.book, bible):
return ""
if (
reference.start_chapter
and reference.end_chapter
and reference.start_chapter == reference.end_chapter
):
return ""
end_chapter = reference.end_chapter or get_number_of_chapters(
reference.book,
bible,
)
return f"{end_chapter}:"
def _get_end_verse(
reference: NormalizedReference,
bible: Bible | None = None,
**kwargs: Any,
) -> str:
force_include_chapters: bool = kwargs.get("always_include_chapter_numbers", False)
if reference.end_book and reference.book != reference.end_book:
if (
_does_reference_include_all_verses_in_end_book(reference, bible)
and not force_include_chapters
):
return ""
end_chapter = reference.end_chapter or get_number_of_chapters(
reference.end_book,
bible,
)
end_verse = reference.end_verse or get_number_of_verses(
reference.end_book,
end_chapter,
bible,
)
return f"{end_verse}"
if (
_does_reference_include_all_verses_in_start_book(reference, bible)
and not force_include_chapters
):
return ""
start_chapter = reference.start_chapter or 1
start_verse = reference.start_verse or 1
end_chapter = reference.end_chapter or get_number_of_chapters(
reference.book,
bible,
)
end_verse = reference.end_verse or get_number_of_verses(
reference.book,
end_chapter,
bible,
)
return (
f"{end_verse}"
if start_verse != end_verse or start_chapter != end_chapter
else ""
)
def _does_reference_include_all_verses_in_start_book(
reference: NormalizedReference,
bible: Bible | None = None,
) -> bool:
if reference.start_chapter is None and reference.end_chapter is None:
return True
if reference.start_chapter != 1:
return False
if reference.start_verse != 1:
return False
if reference.end_book and reference.end_book != reference.book:
return True
max_chapters = get_number_of_chapters(reference.book, bible)
if reference.end_chapter != max_chapters:
return False
return reference.end_verse == get_number_of_verses(
reference.book,
max_chapters,
bible,
)
def _does_reference_include_all_verses_in_end_book(
reference: NormalizedReference,
bible: Bible | None = None,
) -> 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, bible)
if reference.end_chapter != max_chapters:
return False
return reference.end_verse == get_number_of_verses(
end_book,
max_chapters,
bible,
)
def format_scripture_text(
verse_ids: list[int],
**kwargs: Any,
) -> str:
"""Return the formatted scripture text for the given list of verse IDs.
:param verse_ids: A list of integer verse ids
:type verse_ids: list[int]
:return: The formatted scripture text for the verse ids
:rtype: str
:raises VersionMissingBookError: if a book in the verse ids is not present in
the given Bible version
:raises VersionMissingVerseError: if a verse in the verse ids is not present in
the given Bible version
"""
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_verse_numbers: bool = kwargs.get("include_verse_numbers", True)
version: Version = kwargs.get("version", DEFAULT_VERSION)
is_html: bool = format_type == "html"
bible_type = "html" if is_html else "plain_text"
if not include_verse_numbers:
bible_type += "_readers"
bible = get_bible(version, bible_type)
verse_ids.sort()
text: str = ""
current_book: Book | None = None
current_chapter: int | None = None
current_start_verse: int | None = None
current_end_verse: int | None = None
for verse_id in verse_ids:
book, chapter_number, _ = get_book_chapter_verse(verse_id)
if (
one_verse_per_paragraph
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)
text += _format_paragraph(verse_text)
current_start_verse = verse_id
current_end_verse = verse_id
if book != current_book:
current_book = book
current_chapter = chapter_number
title = _get_book_title(book, full_title, bible=bible)
text += _format_title(title, is_html, not text)
text += _format_chapter(chapter_number, is_html)
elif chapter_number != current_chapter:
current_chapter = chapter_number
text += _format_chapter(chapter_number, is_html)
if current_start_verse and current_end_verse:
verse_text = bible.get_scripture(current_start_verse, current_end_verse)
text += _format_paragraph(verse_text)
return text
def _format_title(title: str, is_html: bool, is_first_book: bool) -> str:
if is_html:
return f"<h1>{title}</h1>\n"
return f"{title}\n\n" if is_first_book else f"\n\n{title}\n\n"
def _format_chapter(chapter: int, is_html: bool) -> str:
return f"<h2>Chapter {chapter}</h2>\n" if is_html else f"Chapter {chapter}\n\n"
def _format_paragraph(paragraph: str) -> str:
return f"{paragraph}\n"
@lru_cache()
def get_verse_text(verse_id: int, version: Version = DEFAULT_VERSION) -> str:
"""Return the scripture text of the given verse id and version of the Bible.
:param verse_id: a verse id
:type verse_id: int
:param version: a version of the Bible, defaults to American Standard
:type version: Version
:return: The scripture text of the given verse id and version
:rtype: str
:raises MissingBiblePackageError: if the Bible package for the given version is not
installed
:raises VersionMissingVerseError: if the verse id does not exist in the given Bible
version
"""
bible = get_bible(version, "plain_text_readers")
return bible.get_scripture(verse_id, verse_id)