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.

Sign up for GitHub

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

Jump to bottom

File-opening functions (e.g. uproot.open) should complain about unrecognized arguments #1215

Open
jpivarski opened this issue May 13, 2024 · 0 comments
Open

File-opening functions (e.g. uproot.open) should complain about unrecognized arguments #1215

jpivarski opened this issue May 13, 2024 · 0 comments
Labels
bug The problem described is something that must be fixed

Comments

@jpivarski
Copy link
Member

The processing chain for file-opening ends on the Source constructors, so that means that every Source constructor should raise an error if there are any unused arguments. Maybe each step of the way should pop arguments as they use them (fragile), or each Source should have a set of universal arguments and particular arguments to check (may be redundant).

This might break people's workflows if they want to switch between different Source classes without changing their arguments.

Maybe a weak version of this would have the Source constructor complain if an argument name would not be recognized by any Source class. Arguments that are useless for this Source but meaningful for another would be accepted. I guess that's the best way to do this.

This is a complete set of options (for the union of all Source classes):

uproot5/src/uproot/reading.py

Lines 158 to 168 in 13087b0

open.defaults = {
"handler": None,
"timeout": 30,
"max_num_elements": None,
"num_workers": 1,
"use_threads": sys.platform != "emscripten",
"num_fallback_workers": 10,
"begin_chunk_size": 403, # the smallest a ROOT file can be
"minimal_ttree_metadata": True,
"http_max_header_bytes": 21784,
}

and the regular arguments would also have to be allowed:

uproot5/src/uproot/reading.py

Lines 26 to 35 in 13087b0

def open(
path: str | Path | IO | dict[str | Path | IO, str],
*,
object_cache=100,
array_cache="100 MB",
custom_classes=None,
decompression_executor=None,
interpretation_executor=None,
**options,
):

and

uproot5/src/uproot/behaviors/TBranch.py

Lines 226 to 244 in 13087b0

def concatenate(
files,
expressions=None,
cut=None,
*,
filter_name=no_filter,
filter_typename=no_filter,
filter_branch=no_filter,
aliases=None,
language=uproot.language.python.python_language,
decompression_executor=None,
interpretation_executor=None,
library="ak",
ak_add_doc=False,
how=None,
custom_classes=None,
allow_missing=False,
**options,
):

uproot5/src/uproot/behaviors/TBranch.py

Lines 49 to 69 in 13087b0

def iterate(
files,
expressions=None,
cut=None,
*,
filter_name=no_filter,
filter_typename=no_filter,
filter_branch=no_filter,
aliases=None,
language=uproot.language.python.python_language,
step_size="100 MB",
decompression_executor=None,
interpretation_executor=None,
library="ak",
ak_add_doc=False,
how=None,
report=False,
custom_classes=None,
allow_missing=False,
**options,
):

and

uproot5/src/uproot/_dask.py

Lines 31 to 52 in 13087b0

def dask(
files,
*,
filter_name=no_filter,
filter_typename=no_filter,
filter_branch=no_filter,
recursive=True,
full_paths=False,
step_size=unset,
steps_per_file=unset,
library="ak",
ak_add_doc=False,
custom_classes=None,
allow_missing=False,
open_files=True,
form_mapping=None,
allow_read_errors_with_report=False,
known_base_form=None,
decompression_executor=None,
interpretation_executor=None,
**options,
):

(Those are all of the file-opening functions. I don't think I've left any out.)
@jpivarski jpivarski added the bug The problem described is something that must be fixed label May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug The problem described is something that must be fixed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jpivarski