Models

pydantic model servicex.models.CachedDataset

Bases: BaseModel

Model for a cached dataset held by ServiceX server

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field id: int [Required]

field name: str [Required]

field did_finder: str [Required]

field n_files: int [Required]

field size: int [Required]

field events: int [Required]

field last_used: datetime [Required]

field last_updated: datetime [Required]

field lookup_status: str [Required]

field is_stale: bool [Required]

field files: List[DatasetFile] | None = []

pydantic model servicex.models.DatasetFile

Bases: BaseModel

Model for a file in a cached dataset

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field id: int [Required]

field adler32: str | None [Required]

field file_size: int [Required]

field file_events: int [Required]

field paths: str [Required]

pydantic model servicex.models.DocStringBaseModel

Bases: BaseModel

Class to autogenerate a docstring for a Pydantic model

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

enum servicex.models.ResultDestination(value)

Bases: str, Enum

Direct the output to object store or posix volume

Member Type:

str

Valid values are as follows:

object_store = <ResultDestination.object_store: 'object-store'>

volume = <ResultDestination.volume: 'volume'>

pydantic model servicex.models.ResultFile

Bases: DocStringBaseModel

Record reporting the properties of a transformed file result

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field filename: str [Required]

field size: int [Required]

field extension: str [Required]

enum servicex.models.ResultFormat(value)

Bases: str, Enum

Specify the file format for the generated output

Member Type:

str

Valid values are as follows:

parquet = <ResultFormat.parquet: 'parquet'>

root_ttree = <ResultFormat.root_ttree: 'root-file'>

root_rntuple = <ResultFormat.root_rntuple: 'root-rntuple'>

pydantic model servicex.models.ServiceXInfo

Bases: DocStringBaseModel

Model for ServiceX Info properties

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field app_version: str [Required] (alias 'app-version')

field code_gen_image: dict[str, str] [Required] (alias 'code-gen-image')

field capabilities: list[str] [Optional]

enum servicex.models.Status(value)

Bases: str, Enum

Status of a submitted transform

Member Type:

str

Valid values are as follows:

complete = <Status.complete: 'Complete'>

fatal = <Status.fatal: 'Fatal'>

canceled = <Status.canceled: 'Canceled'>

submitted = <Status.submitted: 'Submitted'>

looking = <Status.looking: 'Lookup'>

pending = <Status.pending: 'Pending Lookup'>

running = <Status.running: 'Running'>

bad_dataset = <Status.bad_dataset: 'Bad Dataset'>

pydantic model servicex.models.TransformRequest

Bases: DocStringBaseModel

Transform request sent to ServiceX

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field title: str | None = None

field did: str | None = None

field file_list: List[str] | None = None (alias 'file-list')

field selection: str [Required]

field codegen: str [Required]

field result_destination: ResultDestination [Required]

field result_format: ResultFormat [Required]

compute_hash()

Compute a hash for this submission. Only include properties that impact the result so we have maximal ability to reuse transforms

Returns:

SHA256 hash of request

pydantic model servicex.models.TransformStatus

Bases: DocStringBaseModel

Status object returned by servicex

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Validators:

• parse_finish_time » finish_time

field request_id: str [Required]

field did: str [Required]

field did_id: int [Required]

field title: str | None = None

field selection: str [Required]

field tree_name: str | None [Required]

field image: str [Required]

field result_destination: ResultDestination [Required]

field result_format: ResultFormat [Required]

field generated_code_cm: str [Required]

field status: Status [Required]

field app_version: str [Required]

field files: int [Required]

field files_completed: int [Required]

field files_failed: int [Required]

field files_remaining: int | None = 0

field submit_time: datetime = None

field finish_time: datetime | None = None

field minio_endpoint: str | None = None

field minio_secured: bool | None = None

field minio_access_key: str | None = None

field minio_secret_key: str | None = None

field log_url: str | None = None

pydantic model servicex.models.TransformedResults

Bases: DocStringBaseModel

Returned for a submission. Gives you everything you need to know about a completed transform.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

field hash: str [Required]

Unique hash for transformation (used to look up results in cache)

field title: str [Required]

Title of transformation request

field codegen: str [Required]

Code generator used (internal ServiceX information related to query type)

field request_id: str [Required]

Associated request ID from the ServiceX server

field submit_time: datetime [Required]

Time of submission

field data_dir: str [Required]

Local directory for output

field file_list: List[str] [Required]

List of downloaded files on local disk

field signed_url_list: List[str] [Required]

List of URLs to retrieve output from remote ServiceX object store

field files: int [Required]

Number of files in result

field result_format: ResultFormat [Required]

File format for results

field log_url: str | None = None

URL for looking up logs on the ServiceX server