schema

Dataset schema definition and enforcement.

Functions

validate_dataset(frame, schema)

Validate a dataset against a given schema.

Classes

BinaryDataset(*args, **kwargs)	Compiled binaries.
BinaryDatasetWithSource(*args, **kwargs)	Binaries with source code.
Dataset(*args, **kwargs)	Base class for all schema.
DisassembledFunctionDataset(*args, **kwargs)	Disassembled functions.
DisassembledFunctionDatasetWithSource(*args, ...)	Disassembled functions with source code.
FunctionDataset(*args, **kwargs)	Individual functions.
FunctionDatasetWithSource(*args, **kwargs)	Functions with source code.
SourceDataset(*args, **kwargs)	Source code.
SummarizedDisassembledFunctionDatasetWithSource(...)	Summarized, disassembled functions with source code.
SummarizedMixin(*args, **kwargs)	A mixin adding a summary field.
SummarizedSourceDataset(*args, **kwargs)	Summarized source code.
TokenizedDataset(*args, **kwargs)	A tokenized dataset.
VulnerabilityDisassembledFunctionDatasetWithSource(...)	Disassembled functions with source code and associated vulnerabilities (if one exists).
VulnerabilityMixin(*args, **kwargs)	A mixin adding a vulnerability field.

class undertale.schema.Dataset(*args, **kwargs)

Bases: DataFrameModel

Base class for all schema.

id: Series[str] = 'id'

Row identifier.

class undertale.schema.SummarizedMixin(*args, **kwargs)

Bases: DataFrameModel

A mixin adding a summary field.

summary: Series[str] = 'summary'

Human-readable summary.

class undertale.schema.SourceDataset(*args, **kwargs)

Bases: Dataset

Source code.

source: Series[str] = 'source'

Source code.

class undertale.schema.SummarizedSourceDataset(*args, **kwargs)

Bases: SummarizedMixin, SourceDataset

Summarized source code.

class undertale.schema.BinaryDataset(*args, **kwargs)

Bases: Dataset

Compiled binaries.

binary: Series[bytes] = 'binary'

Compiled binary code.

class undertale.schema.BinaryDatasetWithSource(*args, **kwargs)

Bases: BinaryDataset, SourceDataset

Binaries with source code.

class undertale.schema.FunctionDataset(*args, **kwargs)

Bases: Dataset

Individual functions.

name: Series[str] = 'name'

The name of the function.

class undertale.schema.FunctionDatasetWithSource(*args, **kwargs)

Bases: FunctionDataset, SourceDataset

Functions with source code.

class undertale.schema.DisassembledFunctionDataset(*args, **kwargs)

Bases: FunctionDataset

Disassembled functions.

class undertale.schema.DisassembledFunctionDatasetWithSource(*args, **kwargs)

Bases: DisassembledFunctionDataset, SourceDataset

Disassembled functions with source code.

class undertale.schema.SummarizedDisassembledFunctionDatasetWithSource(*args, **kwargs)

Bases: SummarizedMixin, DisassembledFunctionDatasetWithSource

Summarized, disassembled functions with source code.

class undertale.schema.VulnerabilityDisassembledFunctionDatasetWithSource(*args, **kwargs)

Bases: VulnerabilityMixin, DisassembledFunctionDatasetWithSource

Disassembled functions with source code and associated vulnerabilities (if one exists).