pylhe.LHEFile

class pylhe.LHEFile(init: LHEInit, events: Iterable[LHEEvent] = ())

Bases: DictCompatibility

Represents an LHE file as a dataclass.

__init__(init: LHEInit, events: Iterable[LHEEvent] = ()) → None

Methods

__init__(init[, events])
clear()
count_events(filepath)	Efficiently count the number of events in an LHE file without loading them into memory.
frombuffer(fileobject[, with_attributes, ...])	Read an LHE file and return an LHEFile object.
fromfile(filepath[, with_attributes, generator])	Read an LHE file and return an LHEFile object.
fromstring(string[, with_attributes, generator])	Create an LHEFile instance from a string in LHE format.
get(k[,d])
items()
keys()
pop(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
popitem()	as a 2-tuple; but raise KeyError if D is empty.
setdefault(k[,d])
tofile(filepath[, gz, rwgt, weights])	Write the LHE file.
tolhe([rwgt, weights])	Return the LHE file as a string.
update([E, ]**F)	If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values()
write(output_stream[, rwgt, weights])	Write the LHE file to an output stream.

Attributes

events	Event block
fieldnames	Return the fieldnames.
init	Init block

clear() → None.  Remove all items from D.

static count_events(filepath: str | bytes | PathLike[str] | PathLike[bytes]) → int

Efficiently count the number of events in an LHE file without loading them into memory.

Args:

filepath: Path to the LHE file.

Returns:

Number of events in the file, or -1 if parsing fails.

events: Iterable[LHEEvent] = ()

Event block

property fieldnames: list[str]

Return the fieldnames.

For backward compatibility with versions < 1.0.0.

Deprecated since version 1.0.0: Listing fieldnames via object.fieldnames is deprecated and will be removed in a future version.

classmethod frombuffer(fileobject: BufferedReader | GzipFile | StringIO | TextIO | BinaryIO, with_attributes: bool = True, generator: bool = True) → LHEFile

Read an LHE file and return an LHEFile object.

classmethod fromfile(filepath: str | bytes | PathLike[str] | PathLike[bytes], with_attributes: bool = True, generator: bool = True) → LHEFile

Read an LHE file and return an LHEFile object.

classmethod fromstring(string: str, with_attributes: bool = True, generator: bool = True) → LHEFile

Create an LHEFile instance from a string in LHE format.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

init: LHEInit

Init block

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

tofile(filepath: str, gz: bool = False, rwgt: bool = True, weights: bool = False) → None

Write the LHE file.

Args:

filepath: Path to the output file. gz: Whether to gzip the output file (ignored if filepath suffix is .gz/.gzip). rwgt: Whether to include weights in ‘rwgt’ format. weights: Whether to include weights in ‘weights’ format.

tolhe(rwgt: bool = True, weights: bool = False) → str

Return the LHE file as a string.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values

write(output_stream: TWriteable, rwgt: bool = True, weights: bool = False) → TWriteable

Write the LHE file to an output stream.