bibpy.entry.entry module

Class representing single entries in a bib file.

class bibpy.entry.entry.Entry(bibtype='', bibkey='', fields=(), **kw_fields)

Bases: bibpy.entry.base.BaseEntry

Represents an entry in a bib file.

abstract

Abstract of the bibliography entry.

addendum

Miscellaneous bibliographic data.

address

An alias for location, provided for BibTeX compatibility.

afterword

The author(s) of an afterword to the work.

aliases(format)

Return any aliases of this entry.

annotation

Annotation for annotated bibliographies.

Not related to the annotator field.

annotator

The author(s) of annotations to the work.

annote

An alias for annotation, provided for jurabib compatibility.

author

The author(s) of the work.

authortype

The type of author.

bibkey

Return the key of this entry.

bibtype

Return the entry type of this entry.

bookauthor

The author(s) of the booktitle.

bookpagination

If the work is published as part of another, this is the pagination scheme of the enclosing work.

booksubtitle

The subtitle related to the booktitle.

booktitle

The title of a larger publication which this work is part of.

booktitleaddon

An annex to the booktitle.

chapter

A chapter or section or any other unit of a work.

clear()

Clear all the fields of this entry.

commentator

The author(s) of a commentary to the work.

crossref

An entry key for cross-referencing.

date

The publication date.

doi

The Digital Object Identifier of the work.

edition

The edition of a printed publication.

editor

The editor(s) of the title, booktitle, or maintitle, depending on the entry.

editora

A secondary editor performing a different editorial role, such as compiling, redacting, etc.

editoratype

Similar to editortype but referring to the editora field.

editorb

Another secondary editor performing a different role.

editorbtype

Similar to editortype but referring to the editorb field.

editorc

Another secondary editor performing a different role.

editorctype

Similar to editortype but referring to the editorc field .

editortype

The type of editorial role performed by the editor.

eid

The electronic identifier of an @article.

entryset

A field is specific to entry sets.

entrysubtype

The subtype of an entry type.

eprint

The electronic identifier of an online publication.

eprintclass

Additional information related to the resource indicated by the eprinttype field.

This could be a section of an archive, a path indicating a service, a classification of some sort, etc.

eprinttype

The type of eprint identifier.

E.g. the name of the archive, repository, service, or system the eprint field refers to.

eventdate

The date of a conference, a symposium, or some other event in @proceedings and @inproceedings entries.

eventtitle

The title of a conference, a symposium, or some other event in @proceedings and @inproceedings entries.

eventtitleaddon

An annex to the eventtitle field.

Can be used for known event acronyms, for example.

execute

A special field which holds arbitrary TeX code.

extra_fields

Return any extra fields not recognised as bibtex or biblatex.

This also ignores user-defined attributes that begin with an underscore.

fields

Return a list of active bib(la)tex fields.

Active fields are fields that are not None or empty strings.

file

A local link to a pdf or other version of the work.

foreword

The author(s) of a foreword to the work.

format(align=True, indent=' ', order=[], surround='{}', **kwargs)

Format and return the entry as a string.

If align is True, align the equal signs of all fields.

The indent is a string that controls the type of indentation before a field.

The order is a either bool that sorts alphabetically if True, or a list of the order of a subset of fields, e.g. [‘author’, ‘title’] would place those two fields in the given order before any other fields.

Additional kwargs are formatting options passed on to the preprocessing function that converts Python types into bibliographic data for writing.

gender

The gender of the author or the gender of the editor, if there is no author.

get(name, default=None)

Return the value for name or default if the name does not exist.

This will also return the default if the name exists (is a valid field) but is set to None.

holder

The holder(s) of a @patent, if different from the author.

howpublished

A notice for unusual publications which do not fit into any of the common categories.

ids

Citation key aliases for the main citation key.

indexsorttitle

The title used when sorting the index.

indextitle

A title to use for indexing instead of the regular title.

institution

The name of a university or some other institution.

introduction

The author(s) of an introduction to the work.

isan

The International Standard Audiovisual Number of an audiovisual work.

isbn

The International Standard Book Number of a book.

isnm

The International Standard Music Number for printed music such as musical scores.

isrn

The International Standard Technical Report Number of a technical report.

issn

The International Standard Serial Number of a periodical.

issue

The issue of a journal.

This field is intended for journals whose individual issues are identified by a designation such as ‘Spring’ or ‘Summer’ rather than the month or a number. Integer ranges and short designators are better written to the number field.

issuesubtitle

The subtitle of a specific issue of a journal or other periodical.

issuetitle

The title of a specific issue of a journal or other periodical.

iswc

The International Standard Work Code of a musical work.

journal

An alias for journaltitle, provided for BibTeX compatibility.

journalsubtitle

The subtitle of a journal, a newspaper, or some other periodical.

journaltitle

The name of a journal, a newspaper, or some other periodical.

key

An alias for sortkey, provided for BibTeX compatibility.

keys()

Return a list of field names in the entry.

keywords

A separated list of keywords.

label

A label to be used by the citation style.

A designation to be used by the citation style as a substitute for the regular label if any data required to generate the regular label is missing. For example, when an author-year citation style is generating a citation for an entry which is missing the author or the year, it may fall back to label.

langid

The language id of the bibliography entry.

langidopts

For polyglossia users, allows per-entry language specific options.

language

The language(s) of the work.

library

Information such as a library name and a call number.

location

The place(s) of publication, i.e., the location of the publisher or institution.

mainsubtitle

The subtitle related to the maintitle.

maintitle

The main title of a multi-volume book.

E.g. ‘Collected Works’.

maintitleaddon

An annex to the maintitle.

month

An annex to the maintitle.

nameaddon

An addon printed immediately after the author name.

note

Miscellaneous bibliographic data which does not fit into any other field.

number

The number of a journal or the volume/number of a book in a series.

With @patent entries, this is the number or record token of a patent or patent request. Normally this field will be an integer or an integer range, but it may also be a short designator that is not entirely numeric such as ‘S1’, ‘Suppl. 2’, ‘3es’.

options

A separated list of entry options in <key>=<value> notation.

This field is used to set options on a per-entry basis.

organization

The organization(s) that published a @manual or @online resource, or sponsored a conference.

origdate

The publication date of the original edition if the work is a translation, reprint etc.

origlanguage

The language(s) of the original work if translated.

origlocation

The location of the original edition if translated or a reprint etc.

origpublisher

The publisher of the original edition, if translated or a reprint etc.

origtitle

The title of the original work if translated.

pages

One or more page numbers or page ranges.

pagetotal

The total number of pages of the work.

pagination

The pagination of the work.

part

The number of a partial volume.

pdf

An alias for file, provided for JabRef compatibility.

presort

A special field used to modify the sorting order.

primaryclass

An alias for eprintclass, provided for arXiv compatibility.

publisher

The name(s) of the publisher(s).

pubstate

The name(s) of the publisher(s).

related

Citation keys of other entries which have a relationship to this entry.

relatedoptions

Per-type options to set for a related entry.

relatedstring

A field used to override the bibliography string specified by relatedtype.

relatedtype

An identifier which specifies the type of relationship for the keys listed in the related field.

reprinttitle

The title of a reprint of the work.

school

An alias for institution, provided for BibTeX compatibility.

series

The name of a publication series.

E.g. ‘Studies in …’, or the number of a journal series. Books in a publication series are usually numbered. The number or volume of a book in a series is given in the number field

shortauthor

The author(s) of the work, given in an abbreviated form.

shorteditor

The editor(s) of the work, given in an abbreviated form.

shorthand

A special designation to be used by the citation style instead of the usual label.

shorthandintro

.

shortjournal

A short version or an acronym of the journaltitle.

shortseries

A short version or an acronym of the series field.

shorttitle

The title in an abridged form.

sortkey

A field used to modify the sorting order.

sortname

A name or a list of names used to modify the sorting order.

sortshorthand

Similar to sortkey but used in the list of shorthands.

sorttitle

A field used to modify the sorting order.

sortyear

A field used to modify the sorting order.

subtitle

The subtitle of the work.

title

The title of the work.

titleaddon

An annex to the title.

translator

The translator(s) of the title or booktitle.

type

The type of a manual, patent, report, or thesis.

url

The url of an online publication.

urldate

The access date of the address specified in the url field.

valid(format)

Return True if all required fields are present, False otherwise.

validate(format)

Raise an error if required fields are missing for the format.

values()

Return a list of field values in the entry.

venue

The location of a conference, a symposium etc. in @proceedings and @inproceedings entries.

version

The revision number of a piece of software, a manual etc.

volume

The volume of a multi-volume book or a periodical.

volumes

The total number of volumes of a multi-volume work.

xdata

This field inherits data @xdata entries.

xref

An alternative cross-referencing mechanism.

year

The year of publication.

bibpy.entry.entry.autoproperty(name, getter=True, setter=True, prefix='_', doc='')

Autogenerate a property.