1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
How to report a bug?
====================
Bugs can be reported on github or via private communications.
Steps
-----
1. Make a minimal code, which reproduces the problem.
2. Provide the code, the bibtex (if necessary), the output.
3. For a parsing error, provide the expected output.
4. For a crash, set the logger to the debug level (see below).
If you want to provide a patch (that's wonderful! thank you), please, take few minutes to write a unit test that fails without your contribution.
Logging module to understand failures
-------------------------------------
Syntax of bibtex files is simple but there are many possible variations. This library probably fails for some of them.
Bibtexparser includes a large quantity of debug messages which helps to understand why and where the parser fails.
The example below can be used to print these messages in the console.
.. code-block:: python
import logging
import logging.config
logger = logging.getLogger(__name__)
logging.config.dictConfig({
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'standard': {
'format': '%(asctime)s [%(levelname)s] %(name)s %(funcName)s:%(lineno)d: %(message)s'
},
},
'handlers': {
'default': {
'level':'DEBUG',
'formatter': 'standard',
'class':'logging.StreamHandler',
},
},
'loggers': {
'': {
'handlers': ['default'],
'level': 'DEBUG',
'formatter': 'standard',
'propagate': True
}
}
})
if __name__ == '__main__':
bibtex = """@ARTICLE{Cesar2013,
author = {Jean César},
title = {An amazing title},
year = {2013},
month = jan,
volume = {12},
pages = {12--23},
journal = {Nice Journal},
abstract = {This is an abstract. This line should be long enough to test
multilines...},
comments = {A comment},
keywords = {keyword1, keyword2},
}
"""
with open('/tmp/bibtex.bib', 'w') as bibfile:
bibfile.write(bibtex)
from bibtexparser.bparser import BibTexParser
with open('/tmp/bibtex.bib', 'r') as bibfile:
bp = BibTexParser(bibfile.read())
print(bp.get_entry_list())
I recommend you to use this output if you would like to report a bug.
|
