Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: added hasattr check to NanoAODEvents __repr__ #909

Merged
merged 20 commits into from
Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/coffea/nanoevents/methods/nanoaod.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@

class _NanoAODEvents(behavior["NanoEvents"]):
def __repr__(self):
return f"<event {self.run}:{self.luminosityBlock}:{self.event}>"
return f"<event {getattr(self,'run','??')}:\
{getattr(self,'luminosityBlock','??')}:\
{getattr(self,'event','??')}>"


behavior["NanoEvents"] = _NanoAODEvents
Expand Down
28 changes: 28 additions & 0 deletions src/coffea/nanoevents/schemas/nanoaod.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,18 @@ class NanoAODSchema(BaseSchema):
There is a class-level variable ``warn_missing_crossrefs`` which will alter the behavior of
NanoAODSchema. If warn_missing_crossrefs is true then when a missing global index cross-ref
target is encountered a warning will be issued. Regardless, the cross-reference is dropped.

The same holds for ``error_missing_events_id``. If error_missing_events_id is true, then when the 'run', 'event',
or 'luminosityBlock' fields are missing, an exception will be thrown; if it is false, just a warning will be issued.
"""

__dask_capable__ = True
warn_missing_crossrefs = True
error_missing_event_ids = True

event_ids = ["run", "luminosityBlock", "event"]
pviscone marked this conversation as resolved.
Show resolved Hide resolved
"""List of NanoAOD event IDs
"""

mixins = {
"CaloMET": "MissingET",
Expand Down Expand Up @@ -206,6 +214,26 @@ def _build_collections(self, field_names, input_contents):
branch_forms["n" + name]
)

# Check the presence of the event_ids
missing_event_ids = [
event_id for event_id in self.event_ids if event_id not in branch_forms
]
if len(missing_event_ids) > 0:
if self.error_missing_event_ids:
raise Exception(
f"There are missing event ID fields: {missing_event_ids} \n\n\
The event ID fields {self.event_ids} are necessary to perform sub-run identification \
(e.g. for corrections and sub-dividing data during different detector conditions),\
to cross-validate MC and Data (i.e. matching events for comparison), and to generate event displays. \
It's advised to never drop these branches from the dataformat.\n\n\
This error can be demoted to a warning by setting the class level variable error_missing_event_ids to False."
)
else:
warnings.warn(
f"Missing event_ids : {missing_event_ids}",
RuntimeWarning,
)

# Create global index virtual arrays for indirection
for indexer, target in self.cross_references.items():
if target.startswith("Gen") and isData:
Expand Down
Binary file added tests/samples/missing_luminosityBlock.root
Binary file not shown.
23 changes: 23 additions & 0 deletions tests/test_nanoevents.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,3 +156,26 @@ def test_read_nanodata(suffix):

crossref(events)
crossref(events[ak.num(events.Jet) > 2])


def test_missing_eventIds_error():
path = os.path.abspath("tests/samples/missing_luminosityBlock.root")
with pytest.raises(
Exception,
match="There are missing event ID fields: ['luminosityBlock'] \n\n\
The event ID fields ['run', 'luminosityBlock', 'event'] are necessary to perform sub-run identification \
(e.g. for corrections and sub-dividing data during different detector conditions),\
to cross-validate MC and Data (i.e. matching events for comparison), and to generate event displays. \
It's advised to never drop these branches from the dataformat.\n\n\
This error can be demoted to a warning by setting the class level variable error_missing_event_ids to False.",
):
factory = NanoEventsFactory.from_root(path, schemaclass=NanoAODSchema)
factory.events()


def test_missing_eventIds_warning():
path = os.path.abspath("tests/samples/missing_luminosityBlock.root")
with pytest.raises(RuntimeWarning, match="Missing event_ids : ['luminosityBlock']"):
NanoAODSchema.error_missing_event_ids = False
Copy link
Contributor Author

@pviscone pviscone Oct 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a safer way to turn the error_missing_events_ids flag to False?
In this way, I think that it will disable it globally

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the intended pattern, it's fine!

factory = NanoEventsFactory.from_root(path, schemaclass=NanoAODSchema)
factory.events()