philoch-bib-sdk 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

philoch_bib_sdk/logic/models.py

@@ -1,8 +1,34 @@
 from __future__ import annotations
-from typing import Tuple
+from typing import Literal, Tuple, get_args
 import attrs
 
-from philoch_bib_sdk.logic.literals import TBibTeXEntryType, TEpoch, TLanguageID, TPubState
+from philoch_bib_sdk.logic.literals import TBasicPubState, TBibTeXEntryType, TEpoch, TLanguageID, TPubState
+
+
+type Maybe[T] = T | None
+type MaybeStr[T] = T | Literal[""]
+
+
+@attrs.define(frozen=True, slots=True)
+class BibStringAttr:
+    """
+    A representation of the different forms of a string we may need for different purposes.
+
+    Args:
+        latex: formatted string for LaTeX, can be used in bib files
+        unicode: formatted string for Unicode, can be used in text. Produced from the LaTeX string
+        simplified: simplified string, can be used to match strings. Produced from the Unicode string
+    """
+
+    latex: str = ""
+    unicode: str = ""
+    simplified: str = ""
+
+
+BibStringLiteral = Literal["latex", "unicode", "simplified"]
+
+type TBibString = BibStringLiteral
+BIB_STRING_VALUES: Tuple[str, ...] = get_args(BibStringLiteral)
 
 
 ############
@@ -13,33 +39,35 @@ from philoch_bib_sdk.logic.literals import TBibTeXEntryType, TEpoch, TLanguageID
 @attrs.define(frozen=True, slots=True)
 class BaseRenderable:
     """
-    Base class for renderable objects, that contain LaTeX code, and possibly a unicode representation of it.
+    Base class for renderable objects that contain a single 'text' attribute.
 
     Args:
-        text: str = ""
-        text_latex: str = ""
-        id: int = -1
+        text: BibString
+        id: Maybe[int] = None
     """
 
-    text: str = ""
-    text_latex: str = ""
-    id: int = -1
+    text: BibStringAttr
+    id: Maybe[int] = None
 
 
 @attrs.define(frozen=True, slots=True)
 class BaseNamedRenderable:
     """
-    Base class for renderable, named, objects, that contain LaTeX code, and possibly a unicode representation of it.
+    Base class for renderable objects that contain a single 'name' attribute.
 
     Args:
-        name: str
-        name_latex: str | None = None
-        id: int | None = None
+        name: BibString
+        id: Maybe[int] = None
     """
 
-    name: str = ""
-    name_latex: str = ""
-    id: int = -1
+    name: BibStringAttr
+    id: Maybe[int] = None
+
+
+RenderablesLiteral = Literal["text", "name"]
+
+type TRenderable = RenderablesLiteral
+RENDERABLES_VALUES: Tuple[str, ...] = get_args(RenderablesLiteral)
 
 
 ############
@@ -53,21 +81,21 @@ class Author:
     An author of a publication.
 
     Args:
-        given_name: str = ""
-        family_name: str = ""
-        given_name_latex: str  = ""
-        family_name_latex: str = ""
-        publications: List[BibItem] = []
-        id: int = -1
+        given_name: BibStringAttr
+        family_name: BibStringAttr
+        given_name_latex: BibStringAttr
+        family_name_latex: BibStringAttr
+        publications: Tuple[BibItem] = []
+        id: Maybe[int] = None
     """
 
-    given_name: str = ""
-    family_name: str = ""
-    given_name_latex: str = ""
-    family_name_latex: str = ""
-    famous_name: str = ""
-    publications: Tuple[BibItem, ...] = ()
-    id: int = -1
+    given_name: BibStringAttr
+    family_name: BibStringAttr
+    mononym: BibStringAttr
+    shorthand: BibStringAttr
+    famous_name: BibStringAttr
+    publications: Tuple[BibItem, ...]
+    id: Maybe[int] = None
 
 
 ############
@@ -81,41 +109,21 @@ class Journal:
     A journal that publishes publications.
 
     Args:
-        name: str = ""
-        name_latex: str = ""
-        issn_print: str = ""
-        issn_electronic: str = ""
-        id: int = -1
-    """
-
-    name: str = ""
-    name_latex: str = ""
-    issn_print: str = ""
-    issn_electronic: str = ""
-    id: int = -1
-
-
-############
-# Note
-############
-
-
-@attrs.define(frozen=True, slots=True)
-class Note(BaseRenderable):
-    """
-    Notes (metadata) about a publication.
-
-    Args:
-        text: str = ""
-        text_latex: str = ""
-        id: int = -1
+        name: BibStringAttr
+        name_latex: str
+        issn_print: str
+        issn_electronic: str
+        id: Maybe[int] = None
     """
 
-    pass
+    name: BibStringAttr
+    issn_print: str
+    issn_electronic: str
+    id: Maybe[int] = None
 
 
 ############
-# Keywords
+# Keyword
 ############
 
 
@@ -125,172 +133,136 @@ class Keyword:
     Keyword of a publication.
 
     Args:
-        name: str = ""
-        id: int = -1
+        name: str
+        id: Maybe[int] = None
     """
 
-    name: str = ""
-    id: int = -1
-
-
-@attrs.define(frozen=True, slots=True)
-class Keywords:
-    level1: Keyword = Keyword()
-    level2: Keyword = Keyword()
-    level3: Keyword = Keyword()
+    name: str
+    id: Maybe[int] = None
 
 
 ############
-# Series, Institution, School, Publisher, Type
+# BibItem
 ############
 
 
-@attrs.define(frozen=True, slots=True)
-class Series(BaseNamedRenderable):
-    """
-    A series of publications.
-
-    Args:
-        name: str = ""
-        name_latex: str = ""
-        id: int = -1
-    """
-
+class BibKeyValidationError(Exception):
     pass
 
 
 @attrs.define(frozen=True, slots=True)
-class Institution(BaseNamedRenderable):
+class BibKeyAttr:
     """
-    An institution that publishes publications.
+    A unique identifier for a publication.
 
     Args:
-        name: str = ""
-        name_latex: str = ""
-        id: int = -1
+        first_author: str
+        other_authors: str
+        date: int | TBasicPubStatus
+        date_suffix: str
     """
 
-    pass
+    first_author: str
+    other_authors: str
+    date: int | TBasicPubState
+    date_suffix: str
 
+    def __attrs_post_init__(self) -> None:
+        if not self.first_author or not self.date:
+            raise BibKeyValidationError("Both 'first_author' and 'date' must not be empty.")
 
-@attrs.define(frozen=True, slots=True)
-class School(BaseNamedRenderable):
-    """
-    A school that publishes publications.
-
-    Args:
-        name: str = ""
-        name_latex: str = ""
-        id: int = -1
-    """
 
+class BibItemDateValidationError(Exception):
     pass
 
 
 @attrs.define(frozen=True, slots=True)
-class Publisher(BaseNamedRenderable):
+class BibItemDateAttr:
     """
-    A publisher of publications.
+    Year of a publication.
+
+    Example:
+        BibItemDate(year=2021, year_revised=2022) represents `2021/2022`.
+        BibItemDate(year=2021, month=1, day=1) represents `2021-01-01`.
 
     Args:
-        name: str = ""
-        name_latex: str = ""
-        id: int = -1
+        year: int
+        year_part_2_hyphen: Maybe[int] = None
+        year_part_2_slash: Maybe[int] = None
+        month: Maybe[int] = None
+        day: Maybe[int] = None
     """
 
-    pass
+    year: int
+    year_part_2_hyphen: Maybe[int] = None
+    year_part_2_slash: Maybe[int] = None
+    month: Maybe[int] = None
+    day: Maybe[int] = None
 
+    def __attrs_post_init__(self) -> None:
+        if any([self.year_part_2_hyphen, self.year_part_2_slash]) and not self.year:
+            raise BibItemDateValidationError(
+                "If 'year_part_2_hyphens' or 'year_part_2_slash' is set, 'year' must not be empty."
+            )
 
-@attrs.define(frozen=True, slots=True)
-class Type(BaseNamedRenderable):
-    """
-    A type of publication.
+        if not ((self.month and self.day) or (not self.month and not self.day)):
+            raise BibItemDateValidationError("If 'day' is set, 'month' must be set too, and vice versa.")
 
-    Args:
-        name: str = ""
-        name_latex: str = ""
-        id: int = -1
-    """
+        if self.month and not self.year:
+            raise BibItemDateValidationError("If 'month' is set, 'year' must not be empty.")
 
-    pass
+        if self.year_part_2_hyphen and self.year_part_2_slash:
+            raise BibItemDateValidationError("If 'year_part_2_hyphen' is set, 'year_part_2_slash' must not be set.")
 
 
-############
-# BibItem
-############
+VALID_DATE_FORMATS = [
+    "{year}",
+    "{year_1}-{year_2}",
+    "{year}/{year_2}",
+    "{year}-{month}-{day}",
+    "{year}-{month}",
+]
 
 
 @attrs.define(frozen=True, slots=True)
-class BibKey:
+class KeywordsAttr:
     """
-    A unique identifier for a publication.
+    Keywords of a publication.
 
     Args:
-        first_author: str = ""
-        year: int | None = None
-        pub_status: TPubState = "published"
-        other_authors: str = ""
-        et_al: bool = False
-        year_suffix
+        level_1: Keyword
+        level_2: Keyword
+        level_3: Keyword
     """
 
-    first_author: str
-    other_authors: str = ""
-    year: int | None = None
-    pub_status: TPubState = ""
-    year_suffix: str = ""
-
+    level_1: Keyword
+    level_2: Keyword
+    level_3: Keyword
 
-@attrs.define(frozen=True, slots=True)
-class BibItemDate:
-    """
-    Year of a publication.
 
-    Example:
-        BibItemDate(year=2021, year_revised=2022) represents `2021/2022`.
-        BibItemDate(year=2021, month=1, day=1) represents `2021-01-01`.
-        BibItemDate(forthcoming=True) represents `forthcoming`.
-
-    Args:
-        year: int | None = None
-        year_revised: int | None = None
-        month: int | None = None
-        day: int | None = None
-        forthcoming: bool | None = None
-    """
-
-    year: int | None = None
-    year_revised: int | None = None
-    month: int | None = None
-    day: int | None = None
-    forthcoming: bool = False
+class PageValidationError(Exception):
+    pass
 
 
 @attrs.define(frozen=True, slots=True)
-class PagePair:
+class PageAttr:
     """
     Page numbers of a publication. Can be a range, roman numerals, or a single page.
 
     Args:
         start: str
-        end: str | None = None
+        end: str
     """
 
     start: str
-    end: str = ""
-
+    end: str
 
-@attrs.define(frozen=True, slots=True)
-class IssueTitle(BaseRenderable):
-    """
-    Title of an issue of a publication.
+    def __attrs_post_init__(self) -> None:
+        if self.end and not self.start:
+            raise PageValidationError("If 'end' is set, 'start' must not be empty.")
 
-    Args:
-        text: str
-        text_latex: str | None = None
-        id: int | None = None
-    """
 
+class BibItemValidationError(Exception):
     pass
 
 
@@ -303,57 +275,92 @@ class BibItem:
 
     """
 
-    _to_do: str = ""
-    _change_request: str = ""
-    entry_type: TBibTeXEntryType = ""
-    bibkey: BibKey | None = None
-    author: Tuple[Author, ...] = ()
-    editor: Tuple[Author, ...] = ()
-    options: Tuple[str, ...] = ()
-    shorthand: str = ""
-    date: BibItemDate | None = None
-    pubstate: TPubState | None = None
-    title: str = ""
-    _title_unicode: str = ""
-    booktitle: str = ""
-    crossref: str = ""
-    journal: Journal | None = None
-    volume: str = ""
-    number: str = ""
-    pages: Tuple[PagePair, ...] = ()
-    eid: str = ""
-    series: Series | None = None
-    address: str = ""
-    institution: str = ""
-    school: str = ""
-    publisher: Publisher | None = None
-    type: Type | None = None
-    edition: str = ""
-    note: Note | None = None
-    issuetitle: IssueTitle | None = None
-    guesteditor: Tuple[Author, ...] = ()
-    further_note: Note | None = None
-    urn: str = ""
-    eprint: str = ""
-    doi: str = ""
-    url: str = ""
-    _kws: Keywords = Keywords()
-    _epoch: TEpoch = ""
-    _person: Author | None = None
-    _comm_for_profile_bib: str = ""
-    langid: TLanguageID = ""
-    _lang_det: str = ""
-    _further_refs: Tuple[BibKey, ...] = ()
-    _depends_on: Tuple[BibKey, ...] = ()
-    dltc_num: int | None = None
-    _spec_interest: str = ""
-    _note_perso: Note | None = None
-    _note_stock: Note | None = None
-    _note_status: Note | None = None
-    _num_in_work: str = ""
-    _num_in_work_coll: int | None = None
-    _num_coll: int | None = None
-    _dltc_copyediting_note: str = ""
-    _note_missing: str = ""
-    _num_sort: int = 0
+    # Normal string fields
+    _to_do_general: str
+    _change_request: str
+
+    # Official fields, may be stored in different formats
+    entry_type: TBibTeXEntryType
+    bibkey: MaybeStr[BibKeyAttr]
+    author: Tuple[Author, ...]
+    editor: Tuple[Author, ...]
+    options: Tuple[str, ...]
+    # shorthand: BibStringAttr  # Mononym of the author
+    date: BibItemDateAttr | Literal["no date"]
+    pubstate: TPubState
+    title: MaybeStr[BibStringAttr]
+    booktitle: MaybeStr[BibStringAttr]
+    crossref: MaybeStr[CrossrefBibItemAttr]
+    journal: Maybe[Journal]
+    volume: str
+    number: str
+    pages: Tuple[PageAttr, ...]
+    eid: str
+    series: MaybeStr[BaseNamedRenderable]
+    address: MaybeStr[BibStringAttr]
+    institution: MaybeStr[BibStringAttr]
+    school: MaybeStr[BibStringAttr]
+    publisher: MaybeStr[BibStringAttr]
+    type: MaybeStr[BibStringAttr]
+    edition: Maybe[int]
+    note: MaybeStr[BibStringAttr]
+    issuetitle: MaybeStr[BibStringAttr]
+    _guesteditor: Tuple[Author, ...]  # Custom field
+    _extra_note: MaybeStr[BibStringAttr]  # Custom field
+    urn: str
+    eprint: str
+    doi: str
+    url: str
+
+    # String fields
+    _kws: MaybeStr[KeywordsAttr]
+    _epoch: TEpoch
+    _person: MaybeStr[Author]
+    _comm_for_profile_bib: str
+    _langid: TLanguageID
+    _lang_der: str
+    _further_refs: Tuple[BibKeyAttr, ...]
+    _depends_on: Tuple[BibKeyAttr, ...]
+    _dltc_num: Maybe[int]
+    _spec_interest: str
+    _note_perso: str
+    _note_stock: str
+    _note_status: str
+    _num_inwork_coll: Maybe[int]
+    _num_inwork: str
+    _num_coll: Maybe[int]
+    _dltc_copyediting_note: str
+    _note_missing: str
+    _num_sort: Maybe[int]
+
+    # Additional fields
+    id: Maybe[int] = None
     _bib_info_source: str = ""
+
+    def __attrs_post_init__(self) -> None:
+
+        if self.crossref and self.bibkey == self.crossref.bibkey:
+            raise BibItemValidationError("Crossref bibkey must be different from the main bibkey.")
+
+
+@attrs.define(frozen=True, slots=True)
+class CrossrefBibItemAttr(BibItem):
+    """
+    A cross-reference to another bibliographic item.
+
+    Args:
+        bibkey: str
+    """
+
+    def __attrs_post_init__(self) -> None:
+        if self.entry_type != "book":
+            raise ValueError("Crossref must have a 'type' of 'book'.")
+
+        if not self.booktitle:
+            raise ValueError("Crossref must have a 'booktitle'.")
+
+        if not self.bibkey:
+            raise ValueError("Crossref must have a 'bibkey'.")
+
+        if self.crossref and self.bibkey == self.crossref.bibkey:
+            raise BibItemValidationError("Crossref bibkey must be different from the main bibkey.")

{philoch_bib_sdk-0.1.2.dist-info → philoch_bib_sdk-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: philoch-bib-sdk
-Version: 0.1.2
+Version: 0.1.4
 Summary: Standard development kit for the Philosophie Bibliography project
 License: MIT
 Author: Luis Alejandro Bordo García
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: aletk (>=0.1.6,<0.2.0)
 Requires-Dist: attrs (>=25.3.0,<26.0.0)
+Requires-Dist: polars (>=1.32.3,<2.0.0)
 Description-Content-Type: text/markdown
 
 # Philosophie.ch Bibliography SDK

philoch_bib_sdk-0.1.4.dist-info/RECORD

@@ -0,0 +1,28 @@
+philoch_bib_sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+philoch_bib_sdk/adapters/tabular_data/read_journal_volume_number_index.py,sha256=espgeln4xH29X1STIDLKiO1IRwmzN5WMjr5QYjPCKls,1757
+philoch_bib_sdk/converters/latex.py,sha256=LuAKLrClECuBeaDQYJc7tIJECEV4h0kt0VE_ssv3s0o,236
+philoch_bib_sdk/converters/plaintext/author/formatter.py,sha256=hsqKUyNhIZeqisnEQU43DokAfEfG78rgQ8POTjYnToM,965
+philoch_bib_sdk/converters/plaintext/author/parser.py,sha256=LL12mtgN59eJCv551c6s7YfMTjfJAJqm-jRQkdntmIg,2514
+philoch_bib_sdk/converters/plaintext/bib_string_formatter.py,sha256=5Z97u5GryHUgZcPhWE41thgWCB4wYu22pZ9et6nakmw,329
+philoch_bib_sdk/converters/plaintext/bibitem/bibkey_formatter.py,sha256=YivsY0gblKJdC4yKYZ3tvWmKIvFXW4iNht9zhz8oFUs,565
+philoch_bib_sdk/converters/plaintext/bibitem/bibkey_parser.py,sha256=lmcDD-NN0hiAF_uKRUcucTBELd_F9q_qjbW9Df7srwY,4624
+philoch_bib_sdk/converters/plaintext/bibitem/date_formatter.py,sha256=G2mbaJidDg8avKBbro1rVcEznPC92XVTDQ4fSdmvhJo,1480
+philoch_bib_sdk/converters/plaintext/bibitem/date_parser.py,sha256=3ZYGhhGqILzrvnwOvG4NPAjErLwVva0dfsN0B9eFomg,2242
+philoch_bib_sdk/converters/plaintext/bibitem/formatter.py,sha256=EjSwHYAPn0YRjeLGK_rCi26Wtug6X5x5DFEKPjStn30,6298
+philoch_bib_sdk/converters/plaintext/bibitem/pages_formatter.py,sha256=punzwm8ObrLJhsCOS1oKHSnTXMX_R_0Xs9M866J44pU,397
+philoch_bib_sdk/converters/plaintext/bibitem/pages_parser.py,sha256=mMFviMZo5qHs0K_SXfbmjJ_nbmTGnSiKMrXyazzO2Qs,2018
+philoch_bib_sdk/converters/plaintext/bibitem/parser.py,sha256=B8xF3OKr6R4-FwsV8iC-cEuY90TEiA22GT5b-WaOwvo,63
+philoch_bib_sdk/converters/plaintext/journal/formatter.py,sha256=o5ikU-aNFr6cxgzD0rBCjymHLpGrD6RGvNE8V2sX52s,599
+philoch_bib_sdk/converters/plaintext/journal/parser.py,sha256=kT1YHwc9Am82WHRhaSWXaCeKitPn9QLWIbmIe8T1of4,1092
+philoch_bib_sdk/converters/plaintext/shared/renderable_formatter.py,sha256=oS5u8RJpkRXaDTmauVqZi-uuXsyG-UQZMK2pgzSk-qo,686
+philoch_bib_sdk/logic/default_models.py,sha256=cHHKSFmNR29qBxQkPwelQ09sx66isHlAIr1PiIHAvH4,10467
+philoch_bib_sdk/logic/functions/comparator.py,sha256=4G5EUEVf8v6URt1v1Fqk1pjqni6fxUs_Goh4EQ4RBJY,4034
+philoch_bib_sdk/logic/functions/journal_article_matcher.py,sha256=qow-szblPDF9ZFaL3nIj-h54rVUwDJz9YXjxycTlTT8,1195
+philoch_bib_sdk/logic/literals.py,sha256=_9poyFdSqbMWNg686xaexvkZTIrpCbQqPNTCVi0PlFc,1573
+philoch_bib_sdk/logic/models.py,sha256=xHCQWFq_rEcX967icALD4oOQjM8AlLKLzXQ8SP-YNis,8681
+philoch_bib_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+philoch_bib_sdk-0.1.4.dist-info/LICENSE,sha256=nplGobji9gkYmJxDBbBz2SKjZY27SUaqhqKkpUB-C30,1070
+philoch_bib_sdk-0.1.4.dist-info/METADATA,sha256=uZJQLAGQRjOtQZCskgWwjaLPZ8UyGkFEAVLcdYjF82I,816
+philoch_bib_sdk-0.1.4.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+philoch_bib_sdk-0.1.4.dist-info/entry_points.txt,sha256=5PDcoKK00cdaL0CabioRUz08ZJeXLa94Ca-C0umGPTU,46
+philoch_bib_sdk-0.1.4.dist-info/RECORD,,

{philoch_bib_sdk-0.1.2.dist-info → philoch_bib_sdk-0.1.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.1
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any

philoch_bib_sdk-0.1.4.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+format=scripts.format:main
+

philoch_bib_sdk-0.1.2.dist-info/RECORD

@@ -1,8 +0,0 @@
-philoch_bib_sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-philoch_bib_sdk/logic/literals.py,sha256=cyoS4Bs9vN35fMkKESlbgLV3YfnRpviZSs4es76t71o,1512
-philoch_bib_sdk/logic/models.py,sha256=b0O7zUP8lzco9Csq5mphGeS2t6Bjyc3LgLELYb-uYt0,7109
-philoch_bib_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-philoch_bib_sdk-0.1.2.dist-info/LICENSE,sha256=nplGobji9gkYmJxDBbBz2SKjZY27SUaqhqKkpUB-C30,1070
-philoch_bib_sdk-0.1.2.dist-info/METADATA,sha256=PLXUGi9pB6CN4OBAUN589G5Dm4X1NB9PVnZXx6oyDaQ,776
-philoch_bib_sdk-0.1.2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-philoch_bib_sdk-0.1.2.dist-info/RECORD,,