servicex.func_adl package

Submodules

servicex.func_adl.func_adl_dataset module

class servicex.func_adl.func_adl_dataset.FuncADLQuery(item_type: Type = typing.Any)

Bases: QueryStringGenerator, EventDataset[T], ABC

ServiceX Dataset class that uses func_adl query syntax.

as_qastle()

Generate Qastle from this AST

Returns:

Qastle representation of the target’s AST

check_data_format_request(f_name: str)

Required override of EventDataset

default_codegen: str | None = None

async execute_result_async(a: AST, title: str | None = None) → Any

Required override of EventDataset

generate_qastle(a: AST) → str

Generate the qastle from the ast of the query.

1. The top level function is already marked as being “ok” 1. If the top level function is something we have to process locally,

then we strip it off.

Parameters:

a (ast.AST) – The complete AST of the request.

Returns:

Qastle that should be sent to servicex

Return type:

str

generate_selection_string() → str

override with the selection string to send to ServiceX

set_provided_qastle(qastle: str)

set_tree(tree_name: str) → FuncADLQuery[T]

Set the tree name for the query. :param tree_name: Name of the tree to use for the query :type tree_name: str

Returns:

The Dataset with the tree appended to the first call object

class servicex.func_adl.func_adl_dataset.FuncADLQuery_ATLASr21(item_type: Type = typing.Any)

Bases: FuncADLQuery

default_codegen: str | None = 'atlasr21'

yaml_tag = '!FuncADL_ATLASr21'

class servicex.func_adl.func_adl_dataset.FuncADLQuery_ATLASr22(item_type: Type = typing.Any)

Bases: FuncADLQuery

default_codegen: str | None = 'atlasr22'

yaml_tag = '!FuncADL_ATLASr22'

class servicex.func_adl.func_adl_dataset.FuncADLQuery_ATLASxAOD(item_type: Type = typing.Any)

Bases: FuncADLQuery

default_codegen: str | None = 'atlasxaod'

yaml_tag = '!FuncADL_ATLASxAOD'

class servicex.func_adl.func_adl_dataset.FuncADLQuery_CMS(item_type: Type = typing.Any)

Bases: FuncADLQuery

default_codegen: str | None = 'cms'

yaml_tag = '!FuncADL_CMS'

class servicex.func_adl.func_adl_dataset.FuncADLQuery_Uproot(item_type: Type = typing.Any)

Bases: FuncADLQuery

FromTree(tree_name)

default_codegen: str | None = 'uproot'

classmethod from_yaml(_, node)

yaml_tag = '!FuncADL_Uproot'

servicex.func_adl.func_adl_dataset_group module

servicex.func_adl.util module

exception servicex.func_adl.util.FuncADLServerException(msg)

Bases: Exception

Thrown when an exception happens contacting the server

servicex.func_adl.util.has_col_names(a: AST) → bool

Determine if any column names were specified in this request.

Parameters:

a (ast.AST) – The complete AST of the request.

Returns:

True if no column names were specified, False otherwise.

Return type:

bool

servicex.func_adl.util.has_tuple(a: AST) → bool

Determine if this query used tuples in its final result

NOTE: This can’t do depth searches in a really complex query - then you need to follow best practices.

Parameters:

a (ast.AST) – The query

Returns:

True if the final Select statement has tuples or not.

Return type:

bool

Module contents