versiref 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

versiref/bible_ref.py

@@ -6,7 +6,7 @@ This module provides classes for representing and manipulating Bible references.
 from dataclasses import dataclass, field
 from typing import Generator, Optional
 
-from versiref.ref_style import RefStyle
+from versiref.ref_style import RefStyle, standard_names
 from versiref.versification import Versification
 
 
@@ -98,6 +98,21 @@ class SimpleBibleRef:
     ranges: list[VerseRange] = field(default_factory=list)
     original_text: Optional[str] = None
 
+    def __str__(self) -> str:
+        """Return a string representation of this simple Bible reference.
+
+        Shows a concise representation using the reference's original text
+        or formatted representation.
+
+        Returns:
+            A string representation of this simple Bible reference
+
+        """
+        ref_part = self.original_text or self.format(
+            RefStyle(names=standard_names("en-sbl_abbreviations"))
+        )
+        return f'SimpleBibleRef("{ref_part}")'
+
     @classmethod
     def for_range(
         cls,
@@ -320,6 +335,23 @@ class BibleRef:
     versification: Optional[Versification] = None
     original_text: Optional[str] = None
 
+    def __str__(self) -> str:
+        """Return a string representation of this Bible reference.
+
+        Shows a concise representation using the versification identifier if available,
+        and the reference's original text or formatted representation.
+
+        Returns:
+            A string representation of this Bible reference
+
+        """
+        ref_part = self.original_text or self.format(
+            RefStyle(names=standard_names("en-sbl_abbreviations"))
+        )
+        if self.versification is None:
+            return f'BibleRef("{ref_part}")'
+        return f'BibleRef("{ref_part}", versification={self.versification})'
+
     @classmethod
     def for_range(
         cls,
@@ -394,6 +426,51 @@ class BibleRef:
             return False
         return all(ref.is_valid(self.versification) for ref in self.simple_refs)
 
+    def range_keys(self) -> Generator[tuple[int, int], None, None]:
+        """Yield an integer key range for each verse range in the ref.
+
+        Book numbers are derived from self.versification, so it cannot be None.
+        If any book ID in the simple refs is not included in the versification,
+        no ranges for that book are yielded.
+
+        Verse numbers less than 0 (undefined) are replaced with:
+        - 0 for start verses
+        - the last verse number for the chapter for end verses
+
+        Yields:
+            (start_key, end_key): integer keys for the start and end of a range in the ref
+                Each key has 2 book digits, 3 chapter digits, and 3 verse digits.
+
+        """
+        if self.versification is None:
+            return
+        for simple_ref in self.simple_refs:
+            if simple_ref.book_id not in self.versification.max_verses:
+                continue
+            else:
+                book_num = (
+                    list(self.versification.max_verses.keys()).index(simple_ref.book_id)
+                    + 1
+                )
+            for range_ref in simple_ref.range_refs():
+                range = range_ref.ranges[0]
+
+                # Replace undefined start verse with 0
+                start_verse = 0 if range.start_verse < 0 else range.start_verse
+
+                # Replace undefined end verse with last verse of chapter
+                end_verse = range.end_verse
+                if end_verse < 0:
+                    end_verse = self.versification.last_verse(
+                        simple_ref.book_id, range.end_chapter
+                    )
+
+                start_key = (
+                    book_num * 1000000 + range.start_chapter * 1000 + start_verse
+                )
+                end_key = book_num * 1000000 + range.end_chapter * 1000 + end_verse
+                yield (start_key, end_key)
+
     def range_refs(self) -> Generator["BibleRef", None, None]:
         """Yield a new BibleRef for each verse range across all simple refs.
 

versiref/data/book_names/en-douay-rheims_names.json

@@ -0,0 +1,78 @@
+{
+  "GEN": "Genesis",
+  "EXO": "Exodus",
+  "LEV": "Leviticus",
+  "NUM": "Numbers",
+  "DEU": "Deuteronomy",
+  "JOS": "Josue",
+  "JDG": "Judges",
+  "RUT": "Ruth",
+  "1SA": "1 Kings",
+  "2SA": "2 Kings",
+  "1KI": "3 Kings",
+  "2KI": "4 Kings",
+  "1CH": "1 Paralipomenon",
+  "2CH": "2 Paralipomenon",
+  "EZR": "1 Esdras",
+  "NEH": "Nehemias",
+  "TOB": "Tobias",
+  "JDT": "Judith",
+  "EST": "Esther",
+  "JOB": "Job",
+  "PSA": "Psalm",
+  "PSAS": "Psalms",
+  "PRO": "Proverbs",
+  "ECC": "Ecclesiastes",
+  "SNG": "Canticle of Canticles",
+  "WIS": "Wisdom",
+  "SIR": "Ecclesiasticus",
+  "ISA": "Isaias",
+  "JER": "Jeremias",
+  "LAM": "Lamentations",
+  "BAR": "Baruch",
+  "EZK": "Ezechiel",
+  "DAN": "Daniel",
+  "HOS": "Osee",
+  "JOL": "Joel",
+  "AMO": "Amos",
+  "OBA": "Abdias",
+  "JON": "Jonas",
+  "MIC": "Micheas",
+  "NAM": "Nahum",
+  "HAB": "Habacuc",
+  "ZEP": "Sophonias",
+  "HAG": "Aggaeus",
+  "ZEC": "Zacharias",
+  "MAL": "Malachias",
+  "1MA": "1 Machabees",
+  "2MA": "2 Machabees",
+  "MAT": "Matthew",
+  "MRK": "Mark",
+  "LUK": "Luke",
+  "JHN": "John",
+  "ACT": "Acts",
+  "ROM": "Romans",
+  "1CO": "1 Corinthians",
+  "2CO": "2 Corinthians",
+  "GAL": "Galatians",
+  "EPH": "Ephesians",
+  "PHP": "Philippians",
+  "COL": "Colossians",
+  "1TH": "1 Thessalonians",
+  "2TH": "2 Thessalonians",
+  "1TI": "1 Timothy",
+  "2TI": "2 Timothy",
+  "TIT": "Titus",
+  "PHM": "Philemon",
+  "HEB": "Hebrews",
+  "JAS": "James",
+  "1PE": "1 Peter",
+  "2PE": "2 Peter",
+  "1JN": "1 John",
+  "2JN": "2 John",
+  "3JN": "3 John",
+  "JUD": "Jude",
+  "REV": "Apocalypse",
+  "1ES": "3 Esdras",
+  "2ES": "4 Esdras"
+}

versiref/versification.py

@@ -13,11 +13,31 @@ class Versification:
     Versifications are defined by JSON data that is loaded from a file when an instance is created.
     The class provides methods to query information about the versification, such as the last verse
     of a given chapter in a given book.
+
+    Attributes:
+        max_verses: last valid verse number for each chapter of each book
+            The order of keys defines the book order.
+        identifier: optional name for the versification
+
     """
 
     max_verses: dict[str, list[int]] = field(default_factory=dict)
     identifier: Optional[str] = None
 
+    def __str__(self) -> str:
+        """Return a string representation of this versification.
+
+        If an identifier is set, returns a concise form: Versification.named("identifier")
+        Otherwise, returns the default dataclass representation.
+
+        Returns:
+            A string representation of this versification
+
+        """
+        if self.identifier:
+            return f'Versification.named("{self.identifier}")'
+        return object.__str__(self)
+
     @classmethod
     def from_file(
         cls, file_path: str, identifier: Optional[str] = None

{versiref-0.1.0.dist-info → versiref-0.2.0.dist-info}/METADATA

@@ -1,10 +1,9 @@
 Metadata-Version: 2.4
 Name: versiref
-Version: 0.1.0
+Version: 0.2.0
 Summary: A package for sophisticated parsing, manipulation, and printing of references to the Bible
-Project-URL: Homepage, https://github.com/fiapps/versiref
-Project-URL: Issues, https://github.com/fiapps/versiref/issues
-Author-email: "Fr. John Lawrence M. Polis" <emptier-sank-dose@duck.com>
+Author: Fr. John Lawrence M. Polis
+Author-email: Fr. John Lawrence M. Polis <emptier-sank-dose@duck.com>
 License-Expression: MIT
 License-File: LICENSE
 Classifier: Development Status :: 3 - Alpha
@@ -18,10 +17,13 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Religion
 Classifier: Topic :: Text Processing
-Requires-Python: >=3.9
 Requires-Dist: pyparsing>=3.2.3
+Requires-Python: >=3.9
+Project-URL: Homepage, https://github.com/fiapps/versiref
+Project-URL: Issues, https://github.com/fiapps/versiref/issues
 Description-Content-Type: text/markdown
 
 # VersiRef

{versiref-0.1.0.dist-info → versiref-0.2.0.dist-info}/RECORD

@@ -1,11 +1,8 @@
 versiref/__init__.py,sha256=3uQ8CnJzBRxQLgoi52Mo4enh3MvarDyya9SVzZdDrp4,601
-versiref/bible_ref.py,sha256=12H25dlIBbZWElsQYNz_ZujFOzr0TXncuDB_23edjW8,16067
-versiref/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-versiref/ref_parser.py,sha256=ef359WpR_tlTumym28_MaH6Zp0dyVixTEm8eHkmIyqQ,22266
-versiref/ref_style.py,sha256=iRPCPqbgJDDvRPmFixLU2IGMDA0inMOZ3mdAB57354Q,4672
-versiref/versification.py,sha256=FQsKJ35YspRLBzkjWSRs6jVOVx1xVqELICJYGQW3LGk,4712
+versiref/bible_ref.py,sha256=loifWIiLdGctxvwFzBM1-X9pLTXUnib28OrYhwD61wQ,19093
 versiref/data/book_names/en-cmos_long.json,sha256=nxSutcEoBVXHvA3UwzKi3Y8z7NEqr_8lTAMelsoDSWc,1517
 versiref/data/book_names/en-cmos_short.json,sha256=8ZO3d3wXGL3FSYj38PBdepjOkbQoSPBNq8_zw-PDGTc,1403
+versiref/data/book_names/en-douay-rheims_names.json,sha256=o3SXK-kSLM3PUZnOEW7JwTmqP2UC3livWjrEMN_r91M,1587
 versiref/data/book_names/en-sbl_abbreviations.json,sha256=8GenBCjOqFUbH25Kzw1eaxb2LMxqJBh8F0UI5peqhzc,1575
 versiref/data/book_names/en-sbl_names.json,sha256=DL3EnhZzAlvYQW0m7rRfrZhDWakVaWrMk5Y-nSivnjQ,1979
 versiref/data/book_names/it-cei_abbreviazioni.json,sha256=U9j2SkqMjJfKb9QHz0rjxjZov6Da7p4tGqDd5p34Sf0,1157
@@ -18,7 +15,11 @@ versiref/data/versifications/org.json,sha256=O44GX7WSEAJl_5686nH1N2kn-gPAhYRPMFj
 versiref/data/versifications/rsc.json,sha256=znZgOjXbV_0OD9A3Oqxu9N-luzjwjXmlv67JiGsxPok,23139
 versiref/data/versifications/rso.json,sha256=Re9PapvlfZs-bogtcEmRp8Sxtk2ftWGoQkAbqIJjNAU,29748
 versiref/data/versifications/vulgata.json,sha256=MI4u2oQbBhPchjuJOunUsNJg1MeAqStPF7DcU42w-MY,33617
-versiref-0.1.0.dist-info/METADATA,sha256=WAzGnjJaNnFLL4r0sWT2v-EdNhYEEH6l8xrV7lK0LWw,5228
-versiref-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-versiref-0.1.0.dist-info/licenses/LICENSE,sha256=15zx8RJP7jG7okR50pC9aCpkaWcCzGDBzKif3PMBXPo,1073
-versiref-0.1.0.dist-info/RECORD,,
+versiref/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+versiref/ref_parser.py,sha256=ef359WpR_tlTumym28_MaH6Zp0dyVixTEm8eHkmIyqQ,22266
+versiref/ref_style.py,sha256=iRPCPqbgJDDvRPmFixLU2IGMDA0inMOZ3mdAB57354Q,4672
+versiref/versification.py,sha256=QP4LYxrofeZNY3TK2Z7o4dfqXqhvogaDcakizXtCEMw,5383
+versiref-0.2.0.dist-info/licenses/LICENSE,sha256=15zx8RJP7jG7okR50pC9aCpkaWcCzGDBzKif3PMBXPo,1073
+versiref-0.2.0.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+versiref-0.2.0.dist-info/METADATA,sha256=5F8Aj521jBPtnQ3XMJboVHtyhuprIZXCjbhSqs6F3KU,5312
+versiref-0.2.0.dist-info/RECORD,,

{versiref-0.1.0.dist-info → versiref-0.2.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: uv 0.9.28
 Root-Is-Purelib: true
 Tag: py3-none-any