-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MAINT: extract Style class to
style module (#4)
* DX: activate VSCode multi-file diff editor https://code.visualstudio.com/updates/v1_85\#_multifile-diff-editor * DX: remove `__init__.py` from search excludes This is legacy from when this plugin was a namespace package. * MAINT: autoupdate pre-commit hooks
- Loading branch information
Showing
4 changed files
with
141 additions
and
134 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| """Style definition for :code:`unsrt_etal`.""" | ||
|
|
||
| # pyright: reportMissingTypeStubs=false | ||
| from __future__ import annotations | ||
|
|
||
| import sys | ||
| from typing import TYPE_CHECKING, ClassVar | ||
|
|
||
| from pybtex.richtext import Tag, Text | ||
| from pybtex.style.formatting.unsrt import Style as UnsrtStyle | ||
| from pybtex.style.template import ( | ||
| FieldIsMissing, | ||
| Node, | ||
| _format_list, # pyright: ignore[reportPrivateUsage] | ||
| field, | ||
| href, | ||
| join, | ||
| node, | ||
| sentence, | ||
| words, | ||
| ) | ||
|
|
||
| if TYPE_CHECKING: | ||
| from pybtex.database import Entry | ||
| if sys.version_info < (3, 8): | ||
| from typing_extensions import Literal | ||
| else: | ||
| from typing import Literal | ||
|
|
||
|
|
||
| ISBNResolvers = Literal["bookfinder", "isbnsearch"] | ||
|
|
||
|
|
||
| # Specify bibliography style | ||
| @node | ||
| def et_al(children, data, sep="", sep2=None, last_sep=None): # type: ignore[no-untyped-def] | ||
| if sep2 is None: | ||
| sep2 = sep | ||
| if last_sep is None: | ||
| last_sep = sep | ||
| parts = [part for part in _format_list(children, data) if part] | ||
| if len(parts) <= 1: | ||
| return Text(*parts) | ||
| if len(parts) == 2: # noqa: PLR2004 | ||
| return Text(sep2).join(parts) | ||
| if len(parts) == 3: # noqa: PLR2004 | ||
| return Text(last_sep).join([Text(sep).join(parts[:-1]), parts[-1]]) | ||
| return Text(parts[0], Tag("em", " et al")) | ||
|
|
||
|
|
||
| @node | ||
| def names(children, context, role, **kwargs): # type: ignore[no-untyped-def] | ||
| """Return formatted names.""" | ||
| if children: | ||
| msg = "The names field should not contain any children" | ||
| raise ValueError(msg) | ||
| try: | ||
| persons = context["entry"].persons[role] | ||
| except KeyError as exc: | ||
| raise FieldIsMissing(role, context["entry"]) from exc | ||
|
|
||
| style = context["style"] | ||
| formatted_names = [ | ||
| style.format_name(person, style.abbreviate_names) for person in persons | ||
| ] | ||
| return et_al(**kwargs)[ # pyright: ignore[reportUntypedBaseClass] | ||
| formatted_names | ||
| ].format_data(context) | ||
|
|
||
|
|
||
| class UnsrtEtAl(UnsrtStyle): | ||
| isbn_resolver: ClassVar[ISBNResolvers] = "bookfinder" | ||
|
|
||
| def __init__(self) -> None: | ||
| super().__init__(abbreviate_names=True) | ||
|
|
||
| def format_names(self, role: Entry, as_sentence: bool = True) -> Node: | ||
| formatted_names = names(role, sep=", ", sep2=" and ", last_sep=", and ") | ||
| if as_sentence: | ||
| return sentence[formatted_names] | ||
| return formatted_names | ||
|
|
||
| def format_eprint(self, e: Entry) -> Node: | ||
| if "doi" in e.fields: | ||
| return "" | ||
| return super().format_eprint(e) | ||
|
|
||
| def format_url(self, e: Entry) -> Node: | ||
| if "doi" in e.fields or "eprint" in e.fields: | ||
| return "" | ||
| return words[ | ||
| href[ | ||
| field("url", raw=True), | ||
| field("url", raw=True, apply_func=remove_http), | ||
| ] | ||
| ] | ||
|
|
||
| def format_isbn(self, e: Entry) -> Node: | ||
| raw_isbn = field("isbn", raw=True, apply_func=remove_dashes_and_spaces) | ||
| if self.isbn_resolver == "bookfinder": | ||
| url = join[ | ||
| "https://www.bookfinder.com/search/?isbn=", | ||
| raw_isbn, | ||
| "&mode=isbn&st=sr&ac=qr", | ||
| ] | ||
| elif self.isbn_resolver == "isbnsearch": | ||
| url = join["https://isbnsearch.org/isbn/", raw_isbn] | ||
| else: | ||
| msg = ( | ||
| f"Unknown unsrt_etal_isbn_resolver: {self.isbn_resolver}. Valid options" | ||
| f" are {', '.join(ISBNResolvers.__args__)}." | ||
| ) | ||
| raise NotImplementedError(msg) | ||
| return href[url, join["ISBN:", field("isbn", raw=True)]] | ||
|
|
||
|
|
||
| def remove_dashes_and_spaces(isbn: str) -> str: | ||
| to_remove = ["-", " "] | ||
| for remove in to_remove: | ||
| isbn = isbn.replace(remove, "") | ||
| return isbn | ||
|
|
||
|
|
||
| def remove_http(url: str) -> str: | ||
| to_remove = ["https://", "http://"] | ||
| for remove in to_remove: | ||
| url = url.replace(remove, "") | ||
| return url |