bibtexparser 1.4.3__tar.gz → 1.4.4__tar.gz

{bibtexparser-1.4.3 → bibtexparser-1.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bibtexparser
-Version: 1.4.3
+Version: 1.4.4
 Summary: Bibtex parser for python 3
 Home-page: https://github.com/sciunto-org/python-bibtexparser
 Author: Francois Boulogne and other contributors

{bibtexparser-1.4.3 → bibtexparser-1.4.4}/bibtexparser/__init__.py

@@ -1,108 +1,108 @@
-"""
-`BibTeX <http://en.wikipedia.org/wiki/BibTeX>`_ is a bibliographic data file format.
-
-The :mod:`bibtexparser` module can parse BibTeX files and write them. The API is similar to the
-:mod:`json` module. The parsed data is returned as a simple :class:`BibDatabase` object with the main attribute being
-:attr:`entries` representing bibliographic sources such as books and journal articles.
-
-The following functions provide a quick and basic way to manipulate a BibTeX file.
-More advanced features are also available in this module.
-
-Parsing a file is as simple as::
-
-    import bibtexparser
-    with open('bibtex.bib') as bibtex_file:
-       bibtex_database = bibtexparser.load(bibtex_file)
-
-And writing::
-
-    import bibtexparser
-    with open('bibtex.bib', 'w') as bibtex_file:
-        bibtexparser.dump(bibtex_database, bibtex_file)
-
-"""
-__all__ = [
-    'loads', 'load', 'dumps', 'dump', 'bibdatabase',
-    'bparser', 'bwriter', 'bibtexexpression', 'latexenc', 'customization',
-]
-__version__ = '1.4.3'
-
-from . import bibdatabase, bibtexexpression, bparser, bwriter, latexenc, customization
-
-
-def loads(bibtex_str, parser=None):
-    """
-    Load :class:`BibDatabase` object from a string
-
-    :param bibtex_str: input BibTeX string to be parsed
-    :type bibtex_str: str or unicode
-    :param parser: custom parser to use (optional)
-    :type parser: BibTexParser
-    :returns: bibliographic database object
-    :rtype: BibDatabase
-    """
-    if parser is None:
-        parser = bparser.BibTexParser()
-    return parser.parse(bibtex_str)
-
-
-def load(bibtex_file, parser=None):
-    """
-    Load :class:`BibDatabase` object from a file
-
-    :param bibtex_file: input file to be parsed
-    :type bibtex_file: file
-    :param parser: custom parser to use (optional)
-    :type parser: BibTexParser
-    :returns: bibliographic database object
-    :rtype: BibDatabase
-
-    Example::
-
-        import bibtexparser
-        with open('bibtex.bib') as bibtex_file:
-           bibtex_database = bibtexparser.load(bibtex_file)
-
-    """
-    if parser is None:
-        parser = bparser.BibTexParser()
-    return parser.parse_file(bibtex_file)
-
-
-def dumps(bib_database, writer=None):
-    """
-    Dump :class:`BibDatabase` object to a BibTeX string
-
-    :param bib_database: bibliographic database object
-    :type bib_database: BibDatabase
-    :param writer: custom writer to use (optional)
-    :type writer: BibTexWriter
-    :returns: BibTeX string
-    :rtype: unicode
-    """
-    if writer is None:
-        writer = bwriter.BibTexWriter()
-    return writer.write(bib_database)
-
-
-def dump(bib_database, bibtex_file, writer=None):
-    """
-    Dump :class:`BibDatabase` object as a BibTeX text file
-
-    :param bib_database: bibliographic database object
-    :type bib_database: BibDatabase
-    :param bibtex_file: file to write to
-    :type bibtex_file: file
-    :param writer: custom writer to use (optional)
-    :type writer: BibTexWriter
-
-    Example::
-
-        import bibtexparser
-        with open('bibtex.bib', 'w') as bibtex_file:
-            bibtexparser.dump(bibtex_database, bibtex_file)
-
-    """
-    if writer is None:
-        writer = bwriter.BibTexWriter()
-    bibtex_file.write(writer.write(bib_database))
+"""
+`BibTeX <http://en.wikipedia.org/wiki/BibTeX>`_ is a bibliographic data file format.
+
+The :mod:`bibtexparser` module can parse BibTeX files and write them. The API is similar to the
+:mod:`json` module. The parsed data is returned as a simple :class:`BibDatabase` object with the main attribute being
+:attr:`entries` representing bibliographic sources such as books and journal articles.
+
+The following functions provide a quick and basic way to manipulate a BibTeX file.
+More advanced features are also available in this module.
+
+Parsing a file is as simple as::
+
+    import bibtexparser
+    with open('bibtex.bib') as bibtex_file:
+       bibtex_database = bibtexparser.load(bibtex_file)
+
+And writing::
+
+    import bibtexparser
+    with open('bibtex.bib', 'w') as bibtex_file:
+        bibtexparser.dump(bibtex_database, bibtex_file)
+
+"""
+__all__ = [
+    'loads', 'load', 'dumps', 'dump', 'bibdatabase',
+    'bparser', 'bwriter', 'bibtexexpression', 'latexenc', 'customization',
+]
+__version__ = '1.4.4'
+
+from . import bibdatabase, bibtexexpression, bparser, bwriter, latexenc, customization
+
+
+def loads(bibtex_str, parser=None):
+    """
+    Load :class:`BibDatabase` object from a string
+
+    :param bibtex_str: input BibTeX string to be parsed
+    :type bibtex_str: str or unicode
+    :param parser: custom parser to use (optional)
+    :type parser: BibTexParser
+    :returns: bibliographic database object
+    :rtype: BibDatabase
+    """
+    if parser is None:
+        parser = bparser.BibTexParser()
+    return parser.parse(bibtex_str)
+
+
+def load(bibtex_file, parser=None):
+    """
+    Load :class:`BibDatabase` object from a file
+
+    :param bibtex_file: input file to be parsed
+    :type bibtex_file: file
+    :param parser: custom parser to use (optional)
+    :type parser: BibTexParser
+    :returns: bibliographic database object
+    :rtype: BibDatabase
+
+    Example::
+
+        import bibtexparser
+        with open('bibtex.bib') as bibtex_file:
+           bibtex_database = bibtexparser.load(bibtex_file)
+
+    """
+    if parser is None:
+        parser = bparser.BibTexParser()
+    return parser.parse_file(bibtex_file)
+
+
+def dumps(bib_database, writer=None):
+    """
+    Dump :class:`BibDatabase` object to a BibTeX string
+
+    :param bib_database: bibliographic database object
+    :type bib_database: BibDatabase
+    :param writer: custom writer to use (optional)
+    :type writer: BibTexWriter
+    :returns: BibTeX string
+    :rtype: unicode
+    """
+    if writer is None:
+        writer = bwriter.BibTexWriter()
+    return writer.write(bib_database)
+
+
+def dump(bib_database, bibtex_file, writer=None):
+    """
+    Dump :class:`BibDatabase` object as a BibTeX text file
+
+    :param bib_database: bibliographic database object
+    :type bib_database: BibDatabase
+    :param bibtex_file: file to write to
+    :type bibtex_file: file
+    :param writer: custom writer to use (optional)
+    :type writer: BibTexWriter
+
+    Example::
+
+        import bibtexparser
+        with open('bibtex.bib', 'w') as bibtex_file:
+            bibtexparser.dump(bibtex_database, bibtex_file)
+
+    """
+    if writer is None:
+        writer = bwriter.BibTexWriter()
+    bibtex_file.write(writer.write(bib_database))

{bibtexparser-1.4.3 → bibtexparser-1.4.4}/bibtexparser/bibtexexpression.py

@@ -29,7 +29,7 @@ def add_logger_parse_action(expr, log_func):
     """Register a callback on expression parsing with the adequate message."""
     def action(s, l, t):
         log_func("Found {}: {}".format(expr.resultsName, t))
-    expr.addParseAction(action)
+    expr.add_parse_action(action)
 
 
 # Parse action helpers
@@ -111,7 +111,7 @@ class BibtexExpression(object):
         # String names
         string_name = pp.Word(pp.alphanums + '_-:')('StringName')
         self.set_string_name_parse_action(lambda s, l, t: None)
-        string_name.addParseAction(self._string_name_parse_action)
+        string_name.add_parse_action(self._string_name_parse_action)
 
         # Values inside bibtex fields
         # Values can be integer or string expressions. The latter may use
@@ -123,27 +123,27 @@ class BibtexExpression(object):
         # Braced values: braced values can contain nested (but balanced) braces
         braced_value_content = pp.CharsNotIn('{}')
         braced_value = pp.Forward()  # Recursive definition for nested braces
-        braced_value <<= pp.originalTextFor(
+        braced_value <<= pp.original_text_for(
             '{' + pp.ZeroOrMore(braced_value | braced_value_content) + '}'
             )('BracedValue')
-        braced_value.setParseAction(remove_braces)
+        braced_value.set_parse_action(remove_braces)
         # TODO add ignore for "\}" and "\{" ?
         # TODO @ are not parsed by bibtex in braces
 
         # Quoted values: may contain braced content with balanced braces
-        brace_in_quoted = pp.nestedExpr('{', '}', ignoreExpr=None)
+        brace_in_quoted = pp.nested_expr('{', '}', ignore_expr=None)
         text_in_quoted = pp.CharsNotIn('"{}')
         # (quotes should be escaped by braces in quoted value)
-        quoted_value = pp.originalTextFor(
+        quoted_value = pp.original_text_for(
             '"' + pp.ZeroOrMore(text_in_quoted | brace_in_quoted) + '"'
             )('QuotedValue')
-        quoted_value.addParseAction(pp.removeQuotes)
+        quoted_value.add_parse_action(pp.remove_quotes)
 
         # String expressions
-        string_expr = pp.delimitedList(
+        string_expr = pp.DelimitedList(
             (quoted_value | braced_value | string_name), delim='#'
             )('StringExpression')
-        string_expr.addParseAction(self._string_expr_parse_action)
+        string_expr.add_parse_action(self._string_expr_parse_action)
 
         value = (integer | string_expr)('Value')
 
@@ -151,7 +151,7 @@ class BibtexExpression(object):
 
         # @EntryType { ...
         entry_type = (pp.Suppress('@') + pp.Word(pp.alphas))('EntryType')
-        entry_type.setParseAction(first_token)
+        entry_type.set_parse_action(first_token)
 
         # Entry key: any character up to a ',' without leading and trailing
         # spaces. Also exclude spaces and prevent it from being empty.
@@ -175,20 +175,20 @@ class BibtexExpression(object):
                         msg="Whitespace not allowed in citekeys.")
             return key
 
-        key.setParseAction(citekeyParseAction)
+        key.set_parse_action(citekeyParseAction)
 
         # Field name: word of letters, digits, dashes and underscores
         field_name = pp.Word(pp.alphanums + '_-().+')('FieldName')
-        field_name.setParseAction(first_token)
+        field_name.set_parse_action(first_token)
 
         # Field: field_name = value
         field = pp.Group(field_name + pp.Suppress('=') + value)('Field')
-        field.setParseAction(field_to_pair)
+        field.set_parse_action(field_to_pair)
 
         # List of fields: comma separeted fields
-        field_list = (pp.delimitedList(field) + pp.Suppress(pp.Optional(','))
+        field_list = (pp.DelimitedList(field) + pp.Suppress(pp.Optional(','))
                       )('Fields')
-        field_list.setParseAction(
+        field_list.set_parse_action(
             lambda s, l, t: {k: v for (k, v) in reversed(t.get('Fields'))})
 
         # Entry: type, key, and fields
@@ -204,10 +204,10 @@ class BibtexExpression(object):
                                    ) | pp.StringEnd()
         self.explicit_comment = (
             pp.Suppress(comment_line_start) +
-            pp.originalTextFor(pp.SkipTo(not_an_implicit_comment),
-                               asString=True))('ExplicitComment')
-        self.explicit_comment.addParseAction(remove_trailing_newlines)
-        self.explicit_comment.addParseAction(remove_braces)
+            pp.original_text_for(pp.SkipTo(not_an_implicit_comment),
+                               as_string=True))('ExplicitComment')
+        self.explicit_comment.add_parse_action(remove_trailing_newlines)
+        self.explicit_comment.add_parse_action(remove_braces)
         # Previous implementation included comment until next '}'.
         # This is however not inline with bibtex behavior that is to only
         # ignore until EOL. Brace stipping is arbitrary here but avoids
@@ -219,10 +219,10 @@ class BibtexExpression(object):
                 raise pp.ParseException("Match must not be empty.")
 
         # Implicit comments: not anything else
-        self.implicit_comment = pp.originalTextFor(
-            pp.SkipTo(not_an_implicit_comment).setParseAction(mustNotBeEmpty),
-            asString=True)('ImplicitComment')
-        self.implicit_comment.addParseAction(remove_trailing_newlines)
+        self.implicit_comment = pp.original_text_for(
+            pp.SkipTo(not_an_implicit_comment).set_parse_action(mustNotBeEmpty),
+            as_string=True)('ImplicitComment')
+        self.implicit_comment.add_parse_action(remove_trailing_newlines)
 
         # String definition
         self.string_def = (pp.Suppress(string_def_start) + in_braces_or_pars(
@@ -274,5 +274,13 @@ class BibtexExpression(object):
     def _string_expr_parse_action(self, s, l, t):
         return BibDataStringExpression.expression_if_needed(t)
 
+    def parse_file(self, file_obj):
+        """Execute parse expression on a file object"""
+        return self.main_expression.parse_file(file_obj, parse_all=True)
+
     def parseFile(self, file_obj):
-        return self.main_expression.parseFile(file_obj, parseAll=True)
+        """Execute parse expression on a file object
+
+        Alias for parse_file()
+        """
+        return self.parse_file(file_obj)

{bibtexparser-1.4.3 → bibtexparser-1.4.4}/bibtexparser/bparser.py

@@ -159,7 +159,7 @@ class BibTexParser(object):
 
         bibtex_file_obj = self._bibtex_file_obj(bibtex_str)
         try:
-            self._expr.parseFile(bibtex_file_obj)
+            self._expr.parse_file(bibtex_file_obj)
         except self._expr.ParseException as exc:
             logger.error("Could not parse properly, starting at %s", exc.line)
             if not partial:
@@ -198,20 +198,20 @@ class BibTexParser(object):
         self._expr.add_log_function(logger.debug)
 
         # Set actions
-        self._expr.entry.addParseAction(
+        self._expr.entry.add_parse_action(
             lambda s, l, t: self._add_entry(
                 t.get('EntryType'), t.get('Key'), t.get('Fields'))
             )
-        self._expr.implicit_comment.addParseAction(
+        self._expr.implicit_comment.add_parse_action(
             lambda s, l, t: self._add_comment(t[0])
             )
-        self._expr.explicit_comment.addParseAction(
+        self._expr.explicit_comment.add_parse_action(
             lambda s, l, t: self._add_comment(t[0])
             )
-        self._expr.preamble_decl.addParseAction(
+        self._expr.preamble_decl.add_parse_action(
             lambda s, l, t: self._add_preamble(t[0])
             )
-        self._expr.string_def.addParseAction(
+        self._expr.string_def.add_parse_action(
             lambda s, l, t: self._add_string(t['StringName'].name,
                                              t['StringValue'])
             )

{bibtexparser-1.4.3 → bibtexparser-1.4.4}/bibtexparser.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bibtexparser
-Version: 1.4.3
+Version: 1.4.4
 Summary: Bibtex parser for python 3
 Home-page: https://github.com/sciunto-org/python-bibtexparser
 Author: Francois Boulogne and other contributors

bibtexparser-1.4.4/requirements.txt

@@ -0,0 +1 @@
+pyparsing>=3.0.0

bibtexparser-1.4.3/requirements.txt

@@ -1 +0,0 @@
-pyparsing>=2.0.3