bibtexparser 2.0.0b7__tar.gz → 2.0.0b9__tar.gz

{bibtexparser-2.0.0b7 → bibtexparser-2.0.0b9}/LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

{bibtexparser-2.0.0b7 → bibtexparser-2.0.0b9}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: bibtexparser
-Version: 2.0.0b7
+Version: 2.0.0b9
 Summary: Bibtex parser for python 3
 Home-page: https://github.com/sciunto-org/python-bibtexparser
 Author: Michael Weiss and other contributors
@@ -10,29 +10,44 @@ Maintainer-email: code@mweiss.ch
 License: MIT
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pylatexenc>=2.10
+Requires-Dist: pylatexenc~=2.10
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-xdist; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: jupyter; extra == "test"
-Provides-Extra: lint
-Requires-Dist: black==23.3.0; extra == "lint"
-Requires-Dist: isort==5.12.0; extra == "lint"
-Requires-Dist: docstr-coverage==2.2.0; extra == "lint"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # python-bibtexparser v2
 
-Welcome to python-bibtexparser, a parser for `.bib` files with a long history and wide adaption.
+Welcome to python-bibtexparser, a parser for `.bib` files with a long history and wide adoption.
 
-Bibtexparser is available in two versions: V1 and V2. For new projects, we recommend using v2 which, in the long run, will provide an overall more robust and faster experience. **For now, however, note that v2 is an early beta, and does not contain all features of v1**. Install v2 using pip:
+Bibtexparser is available in two versions: V1 and V2. For new projects, we recommend using v2 which, in the long run, will provide an overall more robust and faster experience. **For now, however, note that v2 is still in beta stage, and does not contain all features of v1**. Install v2 using pip:
 
 ```bash
 pip install bibtexparser --pre
@@ -49,11 +64,11 @@ If instead, you want to use v1, install it using:
 pip install bibtexparser~=1.0
 ```
 
-Note that all development and maintenance effort is focussed on v2. 
+Note that all development and maintenance effort is focussed on v2.
 Small PRs for v1 are still accepted, but only as long as they are backwards compatible and don't introduce much additional technical debt.
-Development of version one happens on the dedicated [v1 branch](https://github.com/sciunto-org/python-bibtexparser/tree/v1). 
+Development of version one happens on the dedicated [v1 branch](https://github.com/sciunto-org/python-bibtexparser/tree/v1).
 
-The remainder of this README is specific to v2. 
+The remainder of this README is specific to v2.
 
 ## Documentation
 Go check out our documentation on [https://bibtexparser.readthedocs.io/en/main/](https://bibtexparser.readthedocs.io/en/main/).
@@ -91,12 +106,12 @@ bib_database = bibtexparser.parse_string(bibtex_string,
 
 # Let's transform it back to a bibtex_string.
 new_bibtex_string = bibtexparser.write_string(bib_database,
-    # Revert aboves transfomration
+    # Revert above transformation
     prepend_middleware=[MergeNameParts(), MergeCoAuthors()]
 )
 ```
 
-These examples really only show the bare minimum. 
+These examples really only show the bare minimum.
 Consult the documentation for a list of available middleware, parsing options and write-formatting options.
 
 ## V2 Architecture and Terminology
@@ -106,21 +121,21 @@ Consult the documentation for a list of available middleware, parsing options an
 The architecture consists of the following components:
 
 #### Library
-Reflects the contents of a parsed bibtex files, including all comments, entries, strings, preamples and their metadata (e.g. order). 
+Reflects the contents of a parsed bibtex files, including all comments, entries, strings, preambles and their metadata (e.g. order).
 
 #### A Splitter
 Splits a bibtex string into basic blocks (Entry, String, Preamble, ...), with correspondingly split content (e.g. fields on Entry, key-value on String, ...).
-The splitter aims to be forgiving when facing invalid bibtex: A line starting with a block definition (`@....`) ends the previous block, even if not yet every bracket is closed, failing the parsing of the previous block. Correspondingly, one block type is "ParsingFailedBlock".
+The splitter aims to be forgiving when facing invalid bibtex: A line starting with a block definition (``@....``) ends the previous block, even if not yet every bracket is closed, failing the parsing of the previous block. Correspondingly, one block type is "ParsingFailedBlock".
 
 #### Middleware
-Middleware layers transform a library and its blocks, for example by decoding latex special characters, interpolating string references, resoling crossreferences or re-ordering blocks. Thus, the choice of middleware allows to customize parsing and writing to ones specific usecase. Note: Middlewares, by default, no not mutate their input, but return a modified copy. 
+Middleware layers transform a library and its blocks, for example by decoding latex special characters, interpolating string references, resolving crossreferences or re-ordering blocks. Thus, the choice of middleware allows to customize parsing and writing to ones specific usecase. Note: Middlewares, by default, do not mutate their input, but return a modified copy.
 
 #### Writer
-Writes the content of a bibtex library to a `.bib` file. Optional formatting parameters can be passed using a corresponding dedicated data structure.
+Writes the content of a bibtex library to a ``.bib`` file. Optional formatting parameters can be passed using a corresponding dedicated data structure.
 
 ## About
 
-Since 2022, `bibtexparser` is primarily written and maintained by Michael Weiss ([@MiWeiss](https://github.com/MiWeiss/)). In 2024, Tom de Geus ([@tdegeus](https://github.com/tdegeus)) joined as co-maintainer. 
+Since 2022, `bibtexparser` is primarily written and maintained by Michael Weiss ([@MiWeiss](https://github.com/MiWeiss/)). In 2024, Tom de Geus ([@tdegeus](https://github.com/tdegeus)) joined as co-maintainer.
 
 Credits and thanks to the many contributors who helped creating this library, including
 François Boulogne ([@sciunto](https://github.com/sciunto/), creator of the first version) and Olivier Mangin ([@omangin](https://github.com/omangin/), long-term contributor).

{bibtexparser-2.0.0b7 → bibtexparser-2.0.0b9}/README.md

@@ -1,8 +1,8 @@
 # python-bibtexparser v2
 
-Welcome to python-bibtexparser, a parser for `.bib` files with a long history and wide adaption.
+Welcome to python-bibtexparser, a parser for `.bib` files with a long history and wide adoption.
 
-Bibtexparser is available in two versions: V1 and V2. For new projects, we recommend using v2 which, in the long run, will provide an overall more robust and faster experience. **For now, however, note that v2 is an early beta, and does not contain all features of v1**. Install v2 using pip:
+Bibtexparser is available in two versions: V1 and V2. For new projects, we recommend using v2 which, in the long run, will provide an overall more robust and faster experience. **For now, however, note that v2 is still in beta stage, and does not contain all features of v1**. Install v2 using pip:
 
 ```bash
 pip install bibtexparser --pre
@@ -19,11 +19,11 @@ If instead, you want to use v1, install it using:
 pip install bibtexparser~=1.0
 ```
 
-Note that all development and maintenance effort is focussed on v2. 
+Note that all development and maintenance effort is focussed on v2.
 Small PRs for v1 are still accepted, but only as long as they are backwards compatible and don't introduce much additional technical debt.
-Development of version one happens on the dedicated [v1 branch](https://github.com/sciunto-org/python-bibtexparser/tree/v1). 
+Development of version one happens on the dedicated [v1 branch](https://github.com/sciunto-org/python-bibtexparser/tree/v1).
 
-The remainder of this README is specific to v2. 
+The remainder of this README is specific to v2.
 
 ## Documentation
 Go check out our documentation on [https://bibtexparser.readthedocs.io/en/main/](https://bibtexparser.readthedocs.io/en/main/).
@@ -61,12 +61,12 @@ bib_database = bibtexparser.parse_string(bibtex_string,
 
 # Let's transform it back to a bibtex_string.
 new_bibtex_string = bibtexparser.write_string(bib_database,
-    # Revert aboves transfomration
+    # Revert above transformation
     prepend_middleware=[MergeNameParts(), MergeCoAuthors()]
 )
 ```
 
-These examples really only show the bare minimum. 
+These examples really only show the bare minimum.
 Consult the documentation for a list of available middleware, parsing options and write-formatting options.
 
 ## V2 Architecture and Terminology
@@ -76,21 +76,21 @@ Consult the documentation for a list of available middleware, parsing options an
 The architecture consists of the following components:
 
 #### Library
-Reflects the contents of a parsed bibtex files, including all comments, entries, strings, preamples and their metadata (e.g. order). 
+Reflects the contents of a parsed bibtex files, including all comments, entries, strings, preambles and their metadata (e.g. order).
 
 #### A Splitter
 Splits a bibtex string into basic blocks (Entry, String, Preamble, ...), with correspondingly split content (e.g. fields on Entry, key-value on String, ...).
-The splitter aims to be forgiving when facing invalid bibtex: A line starting with a block definition (`@....`) ends the previous block, even if not yet every bracket is closed, failing the parsing of the previous block. Correspondingly, one block type is "ParsingFailedBlock".
+The splitter aims to be forgiving when facing invalid bibtex: A line starting with a block definition (``@....``) ends the previous block, even if not yet every bracket is closed, failing the parsing of the previous block. Correspondingly, one block type is "ParsingFailedBlock".
 
 #### Middleware
-Middleware layers transform a library and its blocks, for example by decoding latex special characters, interpolating string references, resoling crossreferences or re-ordering blocks. Thus, the choice of middleware allows to customize parsing and writing to ones specific usecase. Note: Middlewares, by default, no not mutate their input, but return a modified copy. 
+Middleware layers transform a library and its blocks, for example by decoding latex special characters, interpolating string references, resolving crossreferences or re-ordering blocks. Thus, the choice of middleware allows to customize parsing and writing to ones specific usecase. Note: Middlewares, by default, do not mutate their input, but return a modified copy.
 
 #### Writer
-Writes the content of a bibtex library to a `.bib` file. Optional formatting parameters can be passed using a corresponding dedicated data structure.
+Writes the content of a bibtex library to a ``.bib`` file. Optional formatting parameters can be passed using a corresponding dedicated data structure.
 
 ## About
 
-Since 2022, `bibtexparser` is primarily written and maintained by Michael Weiss ([@MiWeiss](https://github.com/MiWeiss/)). In 2024, Tom de Geus ([@tdegeus](https://github.com/tdegeus)) joined as co-maintainer. 
+Since 2022, `bibtexparser` is primarily written and maintained by Michael Weiss ([@MiWeiss](https://github.com/MiWeiss/)). In 2024, Tom de Geus ([@tdegeus](https://github.com/tdegeus)) joined as co-maintainer.
 
 Credits and thanks to the many contributors who helped creating this library, including
 François Boulogne ([@sciunto](https://github.com/sciunto/), creator of the first version) and Olivier Mangin ([@omangin](https://github.com/omangin/), long-term contributor).

bibtexparser-2.0.0b9/bibtexparser/__init__.py

@@ -0,0 +1,11 @@
+import bibtexparser.exceptions
+import bibtexparser.middlewares
+import bibtexparser.model
+from bibtexparser.entrypoint import parse_file
+from bibtexparser.entrypoint import parse_string
+from bibtexparser.entrypoint import write_file
+from bibtexparser.entrypoint import write_string
+from bibtexparser.library import Library
+from bibtexparser.writer import BibtexFormat
+
+__version__ = "2.0.0b9"

{bibtexparser-2.0.0b7 → bibtexparser-2.0.0b9}/bibtexparser/entrypoint.py

@@ -1,11 +1,18 @@
+import codecs
 import warnings
-from typing import Iterable, List, Optional, TextIO, Union
+from typing import Iterable
+from typing import List
+from typing import Optional
+from typing import TextIO
+from typing import Union
 
 from .library import Library
 from .middlewares.middleware import Middleware
-from .middlewares.parsestack import default_parse_stack, default_unparse_stack
+from .middlewares.parsestack import default_parse_stack
+from .middlewares.parsestack import default_unparse_stack
 from .splitter import Splitter
-from .writer import BibtexFormat, write
+from .writer import BibtexFormat
+from .writer import write
 
 
 def _build_parse_stack(
@@ -14,9 +21,9 @@ def _build_parse_stack(
 ) -> List[Middleware]:
     if parse_stack is not None and append_middleware is not None:
         raise ValueError(
-            "Provided both parse_stack and append_middleware."
-            "Only one should be provided."
-            "(append_middleware should only be used with the default parse_stack,"
+            "Provided both parse_stack and append_middleware. "
+            "Only one should be provided. "
+            "(append_middleware should only be used with the default parse_stack, "
             "i.e., when the passed parse_stack is None.)"
         )
 
@@ -27,7 +34,7 @@ def _build_parse_stack(
         return list(parse_stack)
 
     parse_stack_types = [type(m) for m in parse_stack]
-    append_stack_types = set([type(m) for m in append_middleware])
+    append_stack_types = {type(m) for m in append_middleware}
     stack_types_intersect = set(parse_stack_types).intersection(append_stack_types)
     if len(stack_types_intersect) > 0:
         warnings.warn(
@@ -44,10 +51,10 @@ def _build_unparse_stack(
 ) -> List[Middleware]:
     if unparse_stack is not None and prepend_middleware is not None:
         raise ValueError(
-            "Provided both parse_stack and append_middleware."
-            "Only one should be provided."
-            "(prepend_middleware should only be used with the default parse_stack,"
-            "i.e., when the passed parse_stack is None.)"
+            "Provided both unparse_stack and prepend_middleware. "
+            "Only one should be provided. "
+            "(prepend_middleware should only be used with the default unparse_stack, "
+            "i.e., when the passed unparse_stack is None.)"
         )
 
     if unparse_stack is None:
@@ -57,7 +64,7 @@ def _build_unparse_stack(
         return list(unparse_stack)
 
     parse_stack_types = [type(m) for m in unparse_stack]
-    append_stack_types = set([type(m) for m in prepend_middleware])
+    append_stack_types = {type(m) for m in prepend_middleware}
     stack_types_intersect = set(parse_stack_types).intersection(append_stack_types)
     if len(stack_types_intersect) > 0:
         warnings.warn(
@@ -68,6 +75,52 @@ def _build_unparse_stack(
     return list(prepend_middleware) + list(unparse_stack)
 
 
+def _handle_deprecated_write_params(
+    unparse_stack: Optional[Iterable[Middleware]],
+    prepend_middleware: Optional[Iterable[Middleware]],
+    kwargs: dict,
+    function_name: str,
+) -> tuple[Optional[Iterable[Middleware]], Optional[Iterable[Middleware]]]:
+    """Handle deprecated parameter names for write functions.
+
+    :param unparse_stack: Current unparse_stack value
+    :param prepend_middleware: Current prepend_middleware value
+    :param kwargs: Dictionary of keyword arguments to check for deprecated params
+    :param function_name: Name of the calling function (for error messages)
+    :return: Tuple of (unparse_stack, prepend_middleware) with deprecated values migrated
+    """
+    if "parse_stack" in kwargs:
+        warnings.warn(
+            "Parameter 'parse_stack' is deprecated. Use 'unparse_stack' instead.",
+            DeprecationWarning,
+            stacklevel=3,
+        )
+        if unparse_stack is not None:
+            raise ValueError(
+                "Cannot provide both 'parse_stack' (deprecated) and 'unparse_stack'. "
+                "Use 'unparse_stack' instead."
+            )
+        unparse_stack = kwargs.pop("parse_stack")
+
+    if "append_middleware" in kwargs:
+        warnings.warn(
+            "Parameter 'append_middleware' is deprecated. Use 'prepend_middleware' instead.",
+            DeprecationWarning,
+            stacklevel=3,
+        )
+        if prepend_middleware is not None:
+            raise ValueError(
+                "Cannot provide both 'append_middleware' (deprecated) and 'prepend_middleware'. "
+                "Use 'prepend_middleware' instead."
+            )
+        prepend_middleware = kwargs.pop("append_middleware")
+
+    if kwargs:
+        raise TypeError(f"{function_name}() got unexpected keyword arguments: {', '.join(kwargs)}")
+
+    return unparse_stack, prepend_middleware
+
+
 def parse_string(
     bibtex_str: str,
     parse_stack: Optional[Iterable[Middleware]] = None,
@@ -119,7 +172,13 @@ def parse_file(
 
     :param encoding: Encoding of the .bib file. Default encoding is ``"UTF-8"``.
     :return: Library: Parsed BibTeX library
+    :raises LookupError: If the specified encoding is not recognized.
     """
+    try:
+        codecs.lookup(encoding)
+    except LookupError:
+        raise LookupError(f"Unknown encoding: {encoding!r}")
+
     with open(path, encoding=encoding) as f:
         bibtex_str = f.read()
         return parse_string(
@@ -130,27 +189,39 @@ def parse_file(
 def write_file(
     file: Union[str, TextIO],
     library: Library,
-    parse_stack: Optional[Iterable[Middleware]] = None,
-    append_middleware: Optional[Iterable[Middleware]] = None,
+    unparse_stack: Optional[Iterable[Middleware]] = None,
+    prepend_middleware: Optional[Iterable[Middleware]] = None,
     bibtex_format: Optional[BibtexFormat] = None,
+    encoding: str = "UTF-8",
+    **kwargs,
 ) -> None:
     """Write a BibTeX database to a file.
 
     :param file: File to write to. Can be a file name or a file object.
     :param library: BibTeX database to serialize.
-    :param parse_stack: List of middleware to apply to the database before writing.
+    :param unparse_stack: List of middleware to apply to the database before writing.
                         If None, a default stack will be used.
-    :param append_middleware: List of middleware to append to the default stack.
-                        Only applicable if `parse_stack` is None.
-    :param bibtex_format: Customized BibTeX format to use (optional)."""
+    :param prepend_middleware: List of middleware to prepend to the default stack.
+                        Only applicable if `unparse_stack` is None.
+    :param bibtex_format: Customized BibTeX format to use (optional).
+    :param encoding: Encoding of the .bib file. Default encoding is ``"UTF-8"``.
+
+    .. deprecated:: (next version)
+        Parameters 'parse_stack' and 'append_middleware' are deprecated, will be deleted soon.
+        Use 'unparse_stack' and 'prepend_middleware' instead.
+    """
+    unparse_stack, prepend_middleware = _handle_deprecated_write_params(
+        unparse_stack, prepend_middleware, kwargs, "write_file"
+    )
+
     bibtex_str = write_string(
         library=library,
-        unparse_stack=parse_stack,
-        prepend_middleware=append_middleware,
+        unparse_stack=unparse_stack,
+        prepend_middleware=prepend_middleware,
         bibtex_format=bibtex_format,
     )
     if isinstance(file, str):
-        with open(file, "w") as f:
+        with open(file, "w", encoding=encoding) as f:
             f.write(bibtex_str)
     else:
         file.write(bibtex_str)
@@ -161,6 +232,7 @@ def write_string(
     unparse_stack: Optional[Iterable[Middleware]] = None,
     prepend_middleware: Optional[Iterable[Middleware]] = None,
     bibtex_format: Optional["BibtexFormat"] = None,
+    **kwargs,
 ) -> str:
     """Serialize a BibTeX database to a string.
 
@@ -168,9 +240,17 @@ def write_string(
     :param unparse_stack: List of middleware to apply to the database before writing.
                         If None, a default stack will be used.
     :param prepend_middleware: List of middleware to prepend to the default stack.
-                        Only applicable if `parse_stack` is None.
+                        Only applicable if `unparse_stack` is None.
     :param bibtex_format: Customized BibTeX format to use (optional).
+
+    .. deprecated:: (next version)
+        Parameters 'parse_stack' and 'append_middleware' are deprecated.
+        Use 'unparse_stack' and 'prepend_middleware' instead.
     """
+    unparse_stack, prepend_middleware = _handle_deprecated_write_params(
+        unparse_stack, prepend_middleware, kwargs, "write_string"
+    )
+
     middleware: Middleware
     for middleware in _build_unparse_stack(unparse_stack, prepend_middleware):
         library = middleware.transform(library=library)

{bibtexparser-2.0.0b7 → bibtexparser-2.0.0b9}/bibtexparser/exceptions.py

@@ -1,4 +1,5 @@
-from typing import List, Optional
+from typing import List
+from typing import Optional
 
 
 class ParsingException(Exception):

{bibtexparser-2.0.0b7 → bibtexparser-2.0.0b9}/bibtexparser/library.py

@@ -1,15 +1,15 @@
-from typing import Dict, List, Union
-
-from .model import (
-    Block,
-    DuplicateBlockKeyBlock,
-    Entry,
-    ExplicitComment,
-    ImplicitComment,
-    ParsingFailedBlock,
-    Preamble,
-    String,
-)
+from typing import Dict
+from typing import List
+from typing import Union
+
+from .model import Block
+from .model import DuplicateBlockKeyBlock
+from .model import Entry
+from .model import ExplicitComment
+from .model import ImplicitComment
+from .model import ParsingFailedBlock
+from .model import Preamble
+from .model import String
 
 # TODO Use functools.lru_cache for library properties (which create lists when called)
 
@@ -24,9 +24,7 @@ class Library:
         if blocks is not None:
             self.add(blocks)
 
-    def add(
-        self, blocks: Union[List[Block], Block], fail_on_duplicate_key: bool = False
-    ):
+    def add(self, blocks: Union[List[Block], Block], fail_on_duplicate_key: bool = False):
         """Add blocks to library.
 
         The adding is key-safe, i.e., it is made sure that no duplicate keys are added.
@@ -34,7 +32,8 @@ class Library:
         a DuplicateKeyBlock.
 
         :param blocks: Block or list of blocks to add.
-        :param fail_on_duplicate_key: If True, raises ValueError if a block was replaced with a DuplicateKeyBlock.
+        :param fail_on_duplicate_key:
+            If True, raises ValueError if a block was replaced with a DuplicateKeyBlock.
         """
         if isinstance(blocks, Block):
             blocks = [blocks]
@@ -49,7 +48,7 @@ class Library:
         if fail_on_duplicate_key:
             duplicate_keys = []
             for original, added in zip(blocks, _added_blocks):
-                if not original is added and isinstance(added, DuplicateBlockKeyBlock):
+                if original is not added and isinstance(added, DuplicateBlockKeyBlock):
                     duplicate_keys.append(added.key)
 
             if len(duplicate_keys) > 0:
@@ -74,9 +73,7 @@ class Library:
             elif isinstance(block, String):
                 del self._strings_by_key[block.key]
 
-    def replace(
-        self, old_block: Block, new_block: Block, fail_on_duplicate_key: bool = True
-    ):
+    def replace(self, old_block: Block, new_block: Block, fail_on_duplicate_key: bool = True):
         """Replace a block with another block, at the same position.
 
         :param old_block: Block to replace.
@@ -110,18 +107,22 @@ class Library:
     def _cast_to_duplicate(
         prev_block_with_same_key: Union[Entry, String], duplicate: Union[Entry, String]
     ):
-        assert isinstance(prev_block_with_same_key, type(duplicate)) or isinstance(
-            duplicate, type(prev_block_with_same_key)
-        ), (
-            "Internal BibtexParser Error. Duplicate blocks share no common type."
-            f"Found {type(prev_block_with_same_key)} and {type(duplicate)}, but both should be"
-            f"either instance of String or instance of Entry."
-            f"Please report this issue at the bibtexparser issue tracker.",
-        )
-
-        assert (
-            prev_block_with_same_key.key == duplicate.key
-        ), "Internal BibtexParser Error. Duplicate blocks have different keys."
+        if not (
+            isinstance(prev_block_with_same_key, type(duplicate))
+            or isinstance(duplicate, type(prev_block_with_same_key))
+        ):
+            raise ValueError(
+                "Internal BibtexParser Error. Duplicate blocks share no common type. "
+                f"Found {type(prev_block_with_same_key)} and {type(duplicate)}, but both should be "
+                "either instance of String or instance of Entry. "
+                "Please report this issue at the bibtexparser issue tracker."
+            )
+
+        if prev_block_with_same_key.key != duplicate.key:
+            raise ValueError(
+                "Internal BibtexParser Error. Duplicate blocks have different keys. "
+                "Please report this issue at the bibtexparser issue tracker."
+            )
 
         return DuplicateBlockKeyBlock(
             start_line=duplicate.start_line,
@@ -196,7 +197,5 @@ class Library:
     def comments(self) -> List[Union[ExplicitComment, ImplicitComment]]:
         """All comment blocks in the library, preserving order of insertion."""
         return [
-            block
-            for block in self._blocks
-            if isinstance(block, (ExplicitComment, ImplicitComment))
+            block for block in self._blocks if isinstance(block, (ExplicitComment, ImplicitComment))
         ]

bibtexparser-2.0.0b9/bibtexparser/middlewares/__init__.py

@@ -0,0 +1,22 @@
+from bibtexparser.middlewares.enclosing import AddEnclosingMiddleware
+from bibtexparser.middlewares.enclosing import RemoveEnclosingMiddleware
+from bibtexparser.middlewares.fieldkeys import NormalizeFieldKeys
+from bibtexparser.middlewares.interpolate import ResolveStringReferencesMiddleware
+from bibtexparser.middlewares.latex_encoding import LatexDecodingMiddleware
+from bibtexparser.middlewares.latex_encoding import LatexEncodingMiddleware
+from bibtexparser.middlewares.middleware import BlockMiddleware
+from bibtexparser.middlewares.middleware import LibraryMiddleware
+from bibtexparser.middlewares.month import MonthAbbreviationMiddleware
+from bibtexparser.middlewares.month import MonthIntMiddleware
+from bibtexparser.middlewares.month import MonthLongStringMiddleware
+from bibtexparser.middlewares.names import MergeCoAuthors
+from bibtexparser.middlewares.names import MergeNameParts
+from bibtexparser.middlewares.names import NameParts
+from bibtexparser.middlewares.names import SeparateCoAuthors
+from bibtexparser.middlewares.names import SplitNameParts
+from bibtexparser.middlewares.sorting_blocks import SortBlocksByTypeAndKeyMiddleware
+from bibtexparser.middlewares.sorting_entry_fields import SortFieldsAlphabeticallyMiddleware
+from bibtexparser.middlewares.sorting_entry_fields import SortFieldsCustomMiddleware
+
+from .parsestack import default_parse_stack
+from .parsestack import default_unparse_stack

{bibtexparser-2.0.0b7 → bibtexparser-2.0.0b9}/bibtexparser/middlewares/enclosing.py

@@ -1,6 +1,10 @@
-from typing import Tuple, Union
+from typing import Tuple
+from typing import Union
 
-from bibtexparser.model import Entry, Field, String
+from bibtexparser.library import Library
+from bibtexparser.model import Entry
+from bibtexparser.model import Field
+from bibtexparser.model import String
 
 from .middleware import BlockMiddleware
 
@@ -51,7 +55,7 @@ class RemoveEnclosingMiddleware(BlockMiddleware):
         return value, "no-enclosing"
 
     # docstr-coverage: inherited
-    def transform_entry(self, entry: Entry, library: "Library") -> Entry:
+    def transform_entry(self, entry: Entry, library: Library) -> Entry:
         field: Field
         metadata = dict()
         for field in entry.fields:
@@ -62,7 +66,7 @@ class RemoveEnclosingMiddleware(BlockMiddleware):
         return entry
 
     # docstr-coverage: inherited
-    def transform_string(self, string: String, library: "Library") -> String:
+    def transform_string(self, string: String, library: Library) -> String:
         stripped, enclosing = self._strip_enclosing(string.value)
         string.value = stripped
         string.parser_metadata[self.metadata_key()] = enclosing
@@ -101,8 +105,7 @@ class AddEnclosingMiddleware(BlockMiddleware):
 
         if default_enclosing not in ("{", '"'):
             raise ValueError(
-                "default_enclosing must be either '{' or '\"'"
-                f"not '{default_enclosing}'"
+                "default_enclosing must be either '{' or '\"'" f"not '{default_enclosing}'"
             )
         self._default_enclosing = default_enclosing
         self._reuse_previous_enclosing = reuse_previous_enclosing
@@ -113,9 +116,7 @@ class AddEnclosingMiddleware(BlockMiddleware):
     def metadata_key(cls) -> str:
         return "remove_enclosing"
 
-    def _enclose(
-        self, value: str, metadata_enclosing: str, apply_int_rule: bool
-    ) -> str:
+    def _enclose(self, value: str, metadata_enclosing: str, apply_int_rule: bool) -> str:
         enclosing = self._default_enclosing
         if self._reuse_previous_enclosing and metadata_enclosing is not None:
             enclosing = metadata_enclosing
@@ -129,8 +130,7 @@ class AddEnclosingMiddleware(BlockMiddleware):
         if enclosing == "no-enclosing":
             return value
         raise ValueError(
-            f"enclosing must be either '{{' or '\"' or 'no-enclosing', "
-            f"not '{enclosing}'"
+            f"enclosing must be either '{{' or '\"' or 'no-enclosing', " f"not '{enclosing}'"
         )
 
     # docstr-coverage: inherited
@@ -142,13 +142,9 @@ class AddEnclosingMiddleware(BlockMiddleware):
         for field in entry.fields:
             apply_int_rule = field.key in ENTRY_POTENTIALLY_INT_FIELDS
             prev_encoding = (
-                metadata_enclosing.get(field.key, None)
-                if metadata_enclosing is not None
-                else None
-            )
-            field.value = self._enclose(
-                field.value, prev_encoding, apply_int_rule=apply_int_rule
+                metadata_enclosing.get(field.key, None) if metadata_enclosing is not None else None
             )
+            field.value = self._enclose(field.value, prev_encoding, apply_int_rule=apply_int_rule)
         return entry
 
     # docstr-coverage: inherited