"""Binary classes"""
import binascii
import gzip
import io
import json
import logging
import os
import re
import shutil
import struct
import subprocess
import tarfile
import tempfile
import zipfile
from json import dumps
from typing import (
Any,
Dict,
Iterable,
List,
Optional,
Tuple,
TYPE_CHECKING,
Union,
)
import h5py
import numpy as np
import pysam
from bx.seq.twobit import (
TWOBIT_MAGIC_NUMBER,
TWOBIT_MAGIC_NUMBER_SWAP,
)
from h5grove.content import (
DatasetContent,
get_content_from_file,
ResolvedEntityContent,
)
from h5grove.encoders import encode
from galaxy import util
from galaxy.datatypes import metadata
from galaxy.datatypes.data import (
Data,
DatatypeValidation,
get_file_peek,
)
from galaxy.datatypes.dataproviders.column import (
ColumnarDataProvider,
DictDataProvider,
)
from galaxy.datatypes.dataproviders.dataset import (
DatasetDataProvider,
SamtoolsDataProvider,
SQliteDataDictProvider,
SQliteDataProvider,
SQliteDataTableProvider,
)
from galaxy.datatypes.dataproviders.line import (
FilteredLineDataProvider,
RegexLineDataProvider,
)
from galaxy.datatypes.metadata import (
DictParameter,
FileParameter,
ListParameter,
MetadataElement,
MetadataParameter,
)
from galaxy.datatypes.protocols import (
DatasetHasHidProtocol,
DatasetProtocol,
HasExtraFilesAndMetadata,
HasFileName,
HasMetadata,
)
from galaxy.datatypes.sniff import (
build_sniff_from_prefix,
FilePrefix,
)
from galaxy.datatypes.text import Html
from galaxy.util import (
compression_utils,
nice_size,
sqlite,
UNKNOWN,
)
from galaxy.util.checkers import (
is_bz2,
is_gzip,
is_xz,
)
from . import (
data,
dataproviders,
)
# Optional dependency to enable better metadata support in FITS datatype
try:
from astropy.io import fits
except ModuleNotFoundError:
# If astropy cannot be found FITS datatype will work with minimal metadata support
pass
if TYPE_CHECKING:
from galaxy.util.compression_utils import FileObjType
log = logging.getLogger(__name__)
# pysam 0.16.0.1 emits logs containing the word 'Error', this can confuse the stdout/stderr checkers.
# Can be removed once https://github.com/pysam-developers/pysam/issues/939 is resolved.
pysam.set_verbosity(0)
# Currently these supported binary data types must be manually set on upload
[docs]class Binary(data.Data):
"""Binary data"""
edam_format = "format_2333"
file_ext = "binary"
[docs] @staticmethod
def register_unsniffable_binary_ext(ext):
"""Deprecated method."""
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
"""Set the peek and blurb text"""
if not dataset.dataset.purged:
dataset.peek = "binary data"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def get_mime(self) -> str:
"""Returns the mime type of the datatype"""
return "application/octet-stream"
[docs] def get_structured_content(self, dataset, content_type, **kwargs):
raise Exception("get_structured_content is not implemented for this datatype.")
[docs]class Ab1(Binary):
"""Class describing an ab1 binary sequence file"""
file_ext = "ab1"
edam_format = "format_3000"
edam_data = "data_0924"
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary ab1 sequence file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary ab1 sequence file ({nice_size(dataset.get_size())})"
[docs]class Idat(Binary):
"""Binary data in idat format"""
file_ext = "idat"
edam_format = "format_2058"
edam_data = "data_2603"
[docs] def sniff(self, filename: str) -> bool:
try:
header = open(filename, "rb").read(4)
if header == b"IDAT":
return True
return False
except Exception:
return False
[docs]class Cel(Binary):
"""Cel File format described at:
http://media.affymetrix.com/support/developer/powertools/changelog/gcos-agcc/cel.html
"""
# cel 3 is a text format
is_binary = "maybe"
file_ext = "cel"
edam_format = "format_1638"
edam_data = "data_3110"
MetadataElement(
name="version", default="3", desc="Version", readonly=True, visible=True, optional=True, no_value="3"
)
[docs] def sniff(self, filename: str) -> bool:
"""
Try to guess if the file is a Cel file.
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('affy_v_agcc.cel')
>>> Cel().sniff(fname)
True
>>> fname = get_test_fname('affy_v_3.cel')
>>> Cel().sniff(fname)
True
>>> fname = get_test_fname('affy_v_4.cel')
>>> Cel().sniff(fname)
True
>>> fname = get_test_fname('test.gal')
>>> Cel().sniff(fname)
False
"""
with open(filename, "rb") as handle:
header_bytes = handle.read(8)
found_cel_4 = False
found_cel_3 = False
found_cel_agcc = False
if struct.unpack("<ii", header_bytes[:9]) == (64, 4):
found_cel_4 = True
elif struct.unpack(">bb", header_bytes[:2]) == (59, 1):
found_cel_agcc = True
elif header_bytes.decode("utf8", errors="ignore").startswith("[CEL]"):
found_cel_3 = True
return found_cel_3 or found_cel_4 or found_cel_agcc
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.blurb = f"Cel version: {dataset.metadata.version}"
dataset.peek = get_file_peek(dataset.get_file_name())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs]class MashSketch(Binary):
"""
Mash Sketch file.
Sketches are used by the MinHash algorithm to allow fast distance estimations
with low storage and memory requirements. To make a sketch, each k-mer in a sequence
is hashed, which creates a pseudo-random identifier. By sorting these identifiers (hashes),
a small subset from the top of the sorted list can represent the entire sequence (these are min-hashes).
The more similar another sequence is, the more min-hashes it is likely to share.
"""
file_ext = "msh"
# example data is actually text, maybe text would be a better base
is_binary = "maybe"
[docs]class CompressedArchive(Binary):
"""
Class describing an compressed binary file
This class can be sublass'ed to implement archive filetypes that will not be unpacked by upload.py.
"""
file_ext = "compressed_archive"
compressed = True
is_binary = "maybe"
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Compressed binary file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Compressed binary file ({nice_size(dataset.get_size())})"
[docs]class Meryldb(CompressedArchive):
"""MerylDB is a tar.gz archive, with 128 files. 64 data files and 64 index files."""
file_ext = "meryldb"
[docs] def sniff(self, filename: str) -> bool:
"""
Try to guess if the file is a Cel file.
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('affy_v_agcc.cel')
>>> Meryldb().sniff(fname)
False
>>> fname = get_test_fname('read-db.meryldb')
>>> Meryldb().sniff(fname)
True
"""
try:
if filename and tarfile.is_tarfile(filename):
with tarfile.open(filename, "r") as temptar:
_tar_content = temptar.getnames()
# 64 data files ad 64 indices + 2 folders
if len(_tar_content) == 130:
if len([_ for _ in _tar_content if _.endswith(".merylIndex")]) == 64:
return True
except Exception as e:
log.warning("%s, sniff Exception: %s", self, e)
return False
[docs]class Visium(CompressedArchive):
"""Visium is a tar.gz archive with at least a 'Spatial' subfolder, a filtered h5 file and a raw h5 file."""
file_ext = "visium.tar.gz"
[docs] def sniff(self, filename: str) -> bool:
"""
Check data structure:
Contains h5 files
Contains spatial folder
"""
try:
if filename and tarfile.is_tarfile(filename):
with tarfile.open(filename, "r") as temptar:
_tar_content = temptar.getnames()
if "spatial" in _tar_content:
if len([_ for _ in _tar_content if _.endswith("matrix.h5")]) == 2:
return True
except Exception as e:
log.warning("%s, sniff Exception: %s", self, e)
return False
[docs]class Bref3(Binary):
"""Bref3 format is a binary format for storing phased, non-missing genotypes for a list of samples."""
file_ext = "bref3"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = binascii.unhexlify("7a8874f400156272")
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
return file_prefix.startswith_bytes(self._magic)
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary bref3 file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary bref3 file ({nice_size(dataset.get_size())})"
[docs]class DynamicCompressedArchive(CompressedArchive):
compressed_format: str
uncompressed_datatype_instance: Data
[docs] def matches_any(self, target_datatypes: List[Any]) -> bool:
"""Treat two aspects of compressed datatypes separately."""
compressed_target_datatypes = []
uncompressed_target_datatypes = []
for target_datatype in target_datatypes:
if (
hasattr(target_datatype, "uncompressed_datatype_instance")
and target_datatype.compressed_format == self.compressed_format
):
uncompressed_target_datatypes.append(target_datatype.uncompressed_datatype_instance)
else:
compressed_target_datatypes.append(target_datatype)
# TODO: Add gz and bz2 as proper datatypes and use those instances instead of
# CompressedArchive() in the following check.
if not hasattr(self, "uncompressed_datatype_instance"):
raise Exception("Missing 'uncompressed_datatype_instance' attribute.")
else:
return self.uncompressed_datatype_instance.matches_any(
uncompressed_target_datatypes
) or CompressedArchive().matches_any(compressed_target_datatypes)
[docs]class GzDynamicCompressedArchive(DynamicCompressedArchive):
compressed_format = "gzip"
[docs]class Bz2DynamicCompressedArchive(DynamicCompressedArchive):
compressed_format = "bz2"
[docs]class CompressedZipArchive(CompressedArchive):
"""
Class describing an compressed binary file
This class can be sublass'ed to implement archive filetypes that will not be unpacked by upload.py.
"""
file_ext = "zip"
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Compressed zip file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Compressed zip file ({nice_size(dataset.get_size())})"
[docs] def sniff(self, filename: str) -> bool:
with zipfile.ZipFile(filename) as zf:
zf_files = zf.infolist()
count = 0
for f in zf_files:
if f.file_size > 0 and not f.filename.startswith("__MACOSX/") and not f.filename.endswith(".DS_Store"):
count += 1
if count > 1:
return True
return False
[docs]class GenericAsn1Binary(Binary):
"""Class for generic ASN.1 binary format"""
file_ext = "asn1-binary"
edam_format = "format_1966"
edam_data = "data_0849"
class _BamOrSam:
"""
Helper class to set the metadata common to sam and bam files
"""
def set_meta(self, dataset: DatasetProtocol, overwrite: bool = True, **kwd) -> None:
try:
bam_file = pysam.AlignmentFile(dataset.get_file_name(), mode="rb")
# TODO: Reference names, lengths, read_groups and headers can become very large, truncate when necessary
dataset.metadata.reference_names = list(bam_file.references)
dataset.metadata.reference_lengths = list(bam_file.lengths)
dataset.metadata.bam_header = dict(bam_file.header.items()) # type: ignore [attr-defined]
dataset.metadata.read_groups = [
read_group["ID"] for read_group in dataset.metadata.bam_header.get("RG", []) if "ID" in read_group
]
dataset.metadata.sort_order = dataset.metadata.bam_header.get("HD", {}).get("SO", None)
dataset.metadata.bam_version = dataset.metadata.bam_header.get("HD", {}).get("VN", None)
except Exception:
# Per Dan, don't log here because doing so will cause datasets that
# fail metadata to end in the error state
pass
[docs]class BamNative(CompressedArchive, _BamOrSam):
"""Class describing a BAM binary file that is not necessarily sorted"""
edam_format = "format_2572"
edam_data = "data_0863"
file_ext = "unsorted.bam"
sort_flag: Optional[str] = None
MetadataElement(name="columns", default=12, desc="Number of columns", readonly=True, visible=False, no_value=0)
MetadataElement(
name="column_types",
default=["str", "int", "str", "int", "int", "str", "str", "int", "int", "str", "str", "str"],
desc="Column types",
param=metadata.ColumnTypesParameter,
readonly=True,
visible=False,
no_value=[],
)
MetadataElement(
name="column_names",
default=["QNAME", "FLAG", "RNAME", "POS", "MAPQ", "CIGAR", "MRNM", "MPOS", "ISIZE", "SEQ", "QUAL", "OPT"],
desc="Column names",
readonly=True,
visible=False,
optional=True,
no_value=[],
)
MetadataElement(
name="bam_version",
default=None,
desc="BAM Version",
param=MetadataParameter,
readonly=True,
visible=False,
optional=True,
)
MetadataElement(
name="sort_order",
default=None,
desc="Sort Order",
param=MetadataParameter,
readonly=True,
visible=False,
optional=True,
)
MetadataElement(
name="read_groups",
default=[],
desc="Read Groups",
param=MetadataParameter,
readonly=True,
visible=False,
optional=True,
no_value=[],
)
MetadataElement(
name="reference_names",
default=[],
desc="Chromosome Names",
param=MetadataParameter,
readonly=True,
visible=False,
optional=True,
no_value=[],
)
MetadataElement(
name="reference_lengths",
default=[],
desc="Chromosome Lengths",
param=MetadataParameter,
readonly=True,
visible=False,
optional=True,
no_value=[],
)
MetadataElement(
name="bam_header",
default={},
desc="Dictionary of BAM Headers",
param=MetadataParameter,
readonly=True,
visible=False,
optional=True,
no_value={},
)
[docs] @staticmethod
def merge(split_files: List[str], output_file: str) -> None:
"""
Merges BAM files
:param split_files: List of bam file paths to merge
:param output_file: Write merged bam file to this location
"""
pysam.merge("-O", "BAM", output_file, *split_files) # type: ignore[attr-defined]
[docs] def sniff(self, filename: str) -> bool:
return BamNative.is_bam(filename)
[docs] @classmethod
def is_bam(cls, filename: str) -> bool:
# BAM is compressed in the BGZF format, and must not be uncompressed in Galaxy.
# The first 4 bytes of any bam file is 'BAM\1', and the file is binary.
try:
header = gzip.open(filename).read(4)
if header == b"BAM\1":
return True
return False
except Exception:
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary bam alignments file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary bam alignments file ({nice_size(dataset.get_size())})"
[docs] def to_archive(self, dataset: DatasetProtocol, name: str = "") -> Iterable:
rel_paths = []
file_paths = []
rel_paths.append(f"{name or dataset.get_file_name()}.{dataset.extension}")
file_paths.append(dataset.get_file_name())
# We may or may not have a bam index file (BamNative doesn't have it, but also index generation may have failed)
if dataset.metadata.bam_index:
rel_paths.append(f"{name or dataset.get_file_name()}.{dataset.extension}.bai")
file_paths.append(dataset.metadata.bam_index.get_file_name())
return zip(file_paths, rel_paths)
[docs] def groom_dataset_content(self, file_name: str) -> None:
"""
Ensures that the BAM file contents are coordinate-sorted. This function is called
on an output dataset after the content is initially generated.
"""
# Use pysam to sort the BAM file
# This command may also creates temporary files <out.prefix>.%d.bam when the
# whole alignment cannot fit into memory.
# do this in a unique temp directory, because of possible <out.prefix>.%d.bam temp files
if not self.dataset_content_needs_grooming(file_name):
# Don't re-sort if already sorted
return
tmp_dir = tempfile.mkdtemp()
tmp_sorted_dataset_file_name_prefix = os.path.join(tmp_dir, "sorted")
sorted_file_name = f"{tmp_sorted_dataset_file_name_prefix}.bam"
slots = os.environ.get("GALAXY_SLOTS", 1)
sort_args = []
if self.sort_flag:
sort_args = [self.sort_flag]
sort_args.extend(
[f"-@{slots}", file_name, "-T", tmp_sorted_dataset_file_name_prefix, "-O", "BAM", "-o", sorted_file_name]
)
try:
pysam.sort(*sort_args) # type: ignore[attr-defined]
except Exception:
shutil.rmtree(tmp_dir, ignore_errors=True)
raise
# Move samtools_created_sorted_file_name to our output dataset location
shutil.move(sorted_file_name, file_name)
# Remove temp file and empty temporary directory
os.rmdir(tmp_dir)
[docs] def get_chunk(self, trans, dataset: HasFileName, offset: int = 0, ck_size: Optional[int] = None) -> str:
if not offset == -1:
try:
with pysam.AlignmentFile(dataset.get_file_name(), "rb", check_sq=False) as bamfile:
if ck_size is None:
ck_size = 300 # 300 lines
if offset == 0:
offset = bamfile.tell()
ck_lines = bamfile.text.strip().replace("\t", " ").splitlines() # type: ignore[attr-defined]
else:
bamfile.seek(offset)
ck_lines = []
for line_number, alignment in enumerate(bamfile, len(ck_lines)):
# return only Header lines if 'header_line_count' exceeds 'ck_size'
# FIXME: Can be problematic if bam has million lines of header
if line_number >= ck_size:
break
offset = bamfile.tell()
bamline = alignment.to_string()
# With multiple tags, Galaxy would display each as a separate column
# because the 'to_string()' function uses tabs also between tags.
# Below code will turn these extra tabs into spaces.
n_tabs = bamline.count("\t")
if n_tabs > 11:
bamline, *extra_tags = bamline.rsplit("\t", maxsplit=n_tabs - 11)
bamline = f"{bamline} {' '.join(extra_tags)}"
ck_lines.append(bamline)
else:
# Nothing to enumerate; we've either offset to the end
# of the bamfile, or there is no data. (possible with
# header-only bams)
offset = -1
ck_data = "\n".join(ck_lines)
except Exception as e:
offset = -1
ck_data = f"Could not display BAM file, error was:\n{e}"
else:
ck_data = ""
offset = -1
return dumps({"ck_data": util.unicodify(ck_data), "offset": offset})
[docs] def display_data(
self,
trans,
dataset: DatasetHasHidProtocol,
preview: bool = False,
filename: Optional[str] = None,
to_ext: Optional[str] = None,
offset: Optional[int] = None,
ck_size: Optional[int] = None,
**kwd,
):
headers = kwd.get("headers", {})
preview = util.string_as_bool(preview)
if offset is not None:
return self.get_chunk(trans, dataset, offset, ck_size), headers
elif to_ext or not preview:
return super().display_data(trans, dataset, preview, filename, to_ext, **kwd)
else:
column_names = dataset.metadata.column_names
if not column_names:
column_names = []
column_types = dataset.metadata.column_types
if not column_types:
column_types = []
column_number = dataset.metadata.columns
if column_number is None:
column_number = 1
return (
trans.fill_template(
"/dataset/tabular_chunked.mako",
dataset=dataset,
chunk=self.get_chunk(trans, dataset, 0),
column_number=column_number,
column_names=column_names,
column_types=column_types,
),
headers,
)
[docs] def validate(self, dataset: DatasetProtocol, **kwd) -> DatatypeValidation:
if not BamNative.is_bam(dataset.get_file_name()):
return DatatypeValidation.invalid("This dataset does not appear to a BAM file.")
elif self.dataset_content_needs_grooming(dataset.get_file_name()):
return DatatypeValidation.invalid(
"This BAM file does not appear to have the correct sorting for declared datatype."
)
return DatatypeValidation.validated()
[docs]@dataproviders.decorators.has_dataproviders
class Bam(BamNative):
"""Class describing a BAM binary file"""
edam_format = "format_2572"
edam_data = "data_0863"
file_ext = "bam"
track_type = "ReadTrack"
data_sources = {"data": "bai", "index": "bigwig"}
MetadataElement(
name="bam_index",
desc="BAM Index File",
param=metadata.FileParameter,
file_ext="bai",
readonly=True,
visible=False,
optional=True,
)
MetadataElement(
name="bam_csi_index",
desc="BAM CSI Index File",
param=metadata.FileParameter,
file_ext="bam.csi",
readonly=True,
visible=False,
optional=True,
)
[docs] def get_index_flag(self, file_name: str) -> str:
"""
Return pysam flag for bai index (default) or csi index (contig size > (2**29 - 1) )
"""
index_flag = "-b" # bai index
try:
with pysam.AlignmentFile(file_name) as alignment_file:
if max(alignment_file.header.lengths) > (2**29) - 1:
index_flag = "-c" # csi index
except Exception:
# File may not have a header, that's OK
pass
return index_flag
[docs] def dataset_content_needs_grooming(self, file_name: str) -> bool:
"""
Check if file_name is a coordinate-sorted BAM file
"""
# The best way to ensure that BAM files are coordinate-sorted and indexable
# is to actually index them.
index_flag = self.get_index_flag(file_name)
index_name = tempfile.NamedTemporaryFile(prefix="bam_index").name
try:
# If pysam fails to index a file it will write to stderr,
# and this causes the set_meta script to fail. So instead
# we start another process and discard stderr.
if index_flag == "-b":
# IOError: No such file or directory: '-b' if index_flag is set to -b (pysam 0.15.4)
cmd = [
"python",
"-c",
f"import pysam; pysam.set_verbosity(0); pysam.index('-o', '{index_name}', '{file_name}')",
]
else:
cmd = [
"python",
"-c",
f"import pysam; pysam.set_verbosity(0); pysam.index('{index_flag}', '-o', '{index_name}', '{file_name}')",
]
with open(os.devnull, "w") as devnull:
subprocess.check_call(cmd, stderr=devnull, shell=False)
needs_sorting = False
except subprocess.CalledProcessError:
needs_sorting = True
try:
os.unlink(index_name)
except Exception:
pass
return needs_sorting
[docs] def sniff(self, filename: str) -> bool:
return super().sniff(filename) and not self.dataset_content_needs_grooming(filename)
# ------------- Dataproviders
# pipe through samtools view
# ALSO: (as Sam)
# bam does not use '#' to indicate comments/headers - we need to strip out those headers from the std. providers
# TODO:?? seems like there should be an easier way to do/inherit this - metadata.comment_char?
# TODO: incorporate samtools options to control output: regions first, then flags, etc.
[docs] @dataproviders.decorators.dataprovider_factory("line", FilteredLineDataProvider.settings)
def line_dataprovider(self, dataset: DatasetProtocol, **settings) -> FilteredLineDataProvider:
samtools_source = SamtoolsDataProvider(dataset)
settings["comment_char"] = "@"
return FilteredLineDataProvider(samtools_source, **settings)
[docs] @dataproviders.decorators.dataprovider_factory("regex-line", RegexLineDataProvider.settings)
def regex_line_dataprovider(self, dataset: DatasetProtocol, **settings) -> RegexLineDataProvider:
samtools_source = SamtoolsDataProvider(dataset)
settings["comment_char"] = "@"
return RegexLineDataProvider(samtools_source, **settings)
[docs] @dataproviders.decorators.dataprovider_factory("column", ColumnarDataProvider.settings)
def column_dataprovider(self, dataset: DatasetProtocol, **settings) -> ColumnarDataProvider:
samtools_source = SamtoolsDataProvider(dataset)
settings["comment_char"] = "@"
return ColumnarDataProvider(samtools_source, **settings)
[docs] @dataproviders.decorators.dataprovider_factory("dict", DictDataProvider.settings)
def dict_dataprovider(self, dataset: DatasetProtocol, **settings) -> DictDataProvider:
samtools_source = SamtoolsDataProvider(dataset)
settings["comment_char"] = "@"
return DictDataProvider(samtools_source, **settings)
# these can't be used directly - may need BamColumn, BamDict (Bam metadata -> column/dict)
# OR - see genomic_region_dataprovider
# @dataproviders.decorators.dataprovider_factory('dataset-column', dataproviders.column.ColumnarDataProvider.settings)
# def dataset_column_dataprovider(self, dataset, **settings):
# settings['comment_char'] = '@'
# return super().dataset_column_dataprovider(dataset, **settings)
# @dataproviders.decorators.dataprovider_factory('dataset-dict', dataproviders.column.DictDataProvider.settings)
# def dataset_dict_dataprovider(self, dataset, **settings):
# settings['comment_char'] = '@'
# return super().dataset_dict_dataprovider(dataset, **settings)
[docs] @dataproviders.decorators.dataprovider_factory("id-seq-qual", DictDataProvider.settings)
def id_seq_qual_dataprovider(self, dataset: DatasetProtocol, **settings) -> DictDataProvider:
settings["indeces"] = [0, 9, 10]
settings["column_types"] = ["str", "str", "str"]
settings["column_names"] = ["id", "seq", "qual"]
return self.dict_dataprovider(dataset, **settings)
[docs] @dataproviders.decorators.dataprovider_factory("genomic-region", ColumnarDataProvider.settings)
def genomic_region_dataprovider(self, dataset: DatasetProtocol, **settings) -> ColumnarDataProvider:
# GenomicRegionDataProvider currently requires a dataset as source - may not be necc.
# TODO:?? consider (at least) the possible use of a kwarg: metadata_source (def. to source.dataset),
# or remove altogether...
# samtools_source = dataproviders.dataset.SamtoolsDataProvider(dataset)
# return dataproviders.dataset.GenomicRegionDataProvider(samtools_source, metadata_source=dataset,
# 2, 3, 3, **settings)
# instead, set manually and use in-class column gen
settings["indeces"] = [2, 3, 3]
settings["column_types"] = ["str", "int", "int"]
return self.column_dataprovider(dataset, **settings)
[docs] @dataproviders.decorators.dataprovider_factory("genomic-region-dict", DictDataProvider.settings)
def genomic_region_dict_dataprovider(self, dataset: DatasetProtocol, **settings) -> DictDataProvider:
settings["indeces"] = [2, 3, 3]
settings["column_types"] = ["str", "int", "int"]
settings["column_names"] = ["chrom", "start", "end"]
return self.dict_dataprovider(dataset, **settings)
[docs]class ProBam(Bam):
"""Class describing a BAM binary file - extended for proteomics data"""
edam_format = "format_3826"
edam_data = "data_0863"
file_ext = "probam"
[docs]class BamQuerynameSorted(BamInputSorted):
"""A class for queryname sorted BAM files."""
sort_flag = "-n"
file_ext = "qname_sorted.bam"
[docs] def sniff(self, filename: str) -> bool:
return BamNative().sniff(filename) and not self.dataset_content_needs_grooming(filename)
[docs] def dataset_content_needs_grooming(self, file_name: str) -> bool:
"""
Check if file_name is a queryname-sorted BAM file
"""
# The best way to ensure that BAM files are coordinate-sorted and indexable
# is to actually index them.
with pysam.AlignmentFile(filename=file_name) as f:
return f.header.get("HD", {}).get("SO") != "queryname" # type: ignore[attr-defined]
[docs]class CRAM(Binary):
file_ext = "cram"
edam_format = "format_3462"
edam_data = "data_0863"
MetadataElement(
name="cram_version",
default=None,
desc="CRAM Version",
param=MetadataParameter,
readonly=True,
visible=False,
optional=False,
)
MetadataElement(
name="cram_index",
desc="CRAM Index File",
param=metadata.FileParameter,
file_ext="crai",
readonly=True,
visible=False,
optional=True,
)
[docs] def get_cram_version(self, filename: str) -> Tuple[int, int]:
try:
with open(filename, "rb") as fh:
header = bytearray(fh.read(6))
return header[4], header[5]
except Exception as exc:
log.warning("%s, get_cram_version Exception: %s", self, exc)
return -1, -1
[docs] def set_index_file(self, dataset: HasFileName, index_file) -> bool:
try:
pysam.index("-o", index_file.get_file_name(), dataset.get_file_name()) # type: ignore [attr-defined]
return True
except Exception as exc:
log.warning("%s, set_index_file Exception: %s", self, exc)
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "CRAM binary alignment file"
dataset.blurb = "binary data"
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def sniff(self, filename: str) -> bool:
try:
header = open(filename, "rb").read(4)
if header == b"CRAM":
return True
return False
except Exception:
return False
[docs]class BaseBcf(CompressedArchive):
edam_format = "format_3020"
edam_data = "data_3498"
[docs]class Bcf(BaseBcf):
"""
Class describing a (BGZF-compressed) BCF file
"""
file_ext = "bcf"
MetadataElement(
name="bcf_index",
desc="BCF Index File",
param=metadata.FileParameter,
file_ext="csi",
readonly=True,
visible=False,
optional=True,
)
[docs] def sniff(self, filename: str) -> bool:
# BCF is compressed in the BGZF format, and must not be uncompressed in Galaxy.
try:
header = gzip.open(filename).read(3)
# The first 3 bytes of any BCF file are 'BCF', and the file is binary.
if header == b"BCF":
return True
return False
except Exception:
return False
[docs]class BcfUncompressed(BaseBcf):
"""
Class describing an uncompressed BCF file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('1.bcf_uncompressed')
>>> BcfUncompressed().sniff(fname)
True
>>> fname = get_test_fname('1.bcf')
>>> BcfUncompressed().sniff(fname)
False
"""
file_ext = "bcf_uncompressed"
compressed = False
[docs] def sniff(self, filename: str) -> bool:
try:
header = open(filename, mode="rb").read(3)
# The first 3 bytes of any BCF file are 'BCF', and the file is binary.
if header == b"BCF":
return True
return False
except Exception:
return False
[docs]class H5(Binary):
"""
Class describing an HDF5 file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.mz5')
>>> H5().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> H5().sniff(fname)
False
"""
file_ext = "h5"
edam_format = "format_3590"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = binascii.unhexlify("894844460d0a1a0a")
[docs] def sniff(self, filename: str) -> bool:
# The first 8 bytes of any hdf5 file are 0x894844460d0a1a0a
try:
header = open(filename, "rb").read(8)
if header == self._magic:
return True
return False
except Exception:
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary HDF5 file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary HDF5 file ({nice_size(dataset.get_size())})"
[docs] def get_structured_content(
self,
dataset,
content_type=None,
path="/",
dtype="origin",
format="json",
flatten=False,
selection=None,
**kwargs,
):
"""
Implements h5grove protocol (https://silx-kit.github.io/h5grove/).
This allows the h5web visualization tool (https://github.com/silx-kit/h5web)
to be used directly with Galaxy datasets.
"""
with get_content_from_file(dataset.get_file_name(), path, self._create_error) as content:
if content_type == "attr":
assert isinstance(content, ResolvedEntityContent)
resp = encode(content.attributes(), "json")
elif content_type == "meta":
resp = encode(content.metadata(), "json")
elif content_type == "stats":
assert isinstance(content, DatasetContent)
resp = encode(content.data_stats(selection), "json")
else: # default 'data'
assert isinstance(content, DatasetContent)
resp = encode(content.data(selection, flatten, dtype), format)
return resp.content, resp.headers
def _create_error(self, status_code, message):
return Exception(status_code, message)
[docs]class Loom(H5):
"""
Class describing a Loom file: http://loompy.org/
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.loom')
>>> Loom().sniff(fname)
True
>>> fname = get_test_fname('test.mz5')
>>> Loom().sniff(fname)
False
"""
file_ext = "loom"
edam_format = "format_3590"
MetadataElement(name="title", default="", desc="title", readonly=True, visible=True, no_value="")
MetadataElement(name="description", default="", desc="description", readonly=True, visible=True, no_value="")
MetadataElement(name="url", default="", desc="url", readonly=True, visible=True, no_value="")
MetadataElement(name="doi", default="", desc="doi", readonly=True, visible=True, no_value="")
MetadataElement(
name="loom_spec_version", default="", desc="loom_spec_version", readonly=True, visible=True, no_value=""
)
MetadataElement(name="creation_date", default=None, desc="creation_date", readonly=True, visible=True)
MetadataElement(
name="shape", default=(), desc="shape", param=metadata.ListParameter, readonly=True, visible=True, no_value=()
)
MetadataElement(name="layers_count", default=0, desc="layers_count", readonly=True, visible=True, no_value=0)
MetadataElement(
name="layers_names",
desc="layers_names",
default=[],
param=metadata.SelectParameter,
multiple=True,
readonly=True,
)
MetadataElement(name="row_attrs_count", default=0, desc="row_attrs_count", readonly=True, visible=True, no_value=0)
MetadataElement(
name="row_attrs_names",
desc="row_attrs_names",
default=[],
param=metadata.SelectParameter,
multiple=True,
readonly=True,
)
MetadataElement(name="col_attrs_count", default=0, desc="col_attrs_count", readonly=True, visible=True, no_value=0)
MetadataElement(
name="col_attrs_names",
desc="col_attrs_names",
default=[],
param=metadata.SelectParameter,
multiple=True,
readonly=True,
)
MetadataElement(
name="col_graphs_count", default=0, desc="col_graphs_count", readonly=True, visible=True, no_value=0
)
MetadataElement(
name="col_graphs_names",
desc="col_graphs_names",
default=[],
param=metadata.SelectParameter,
multiple=True,
readonly=True,
)
MetadataElement(
name="row_graphs_count", default=0, desc="row_graphs_count", readonly=True, visible=True, no_value=0
)
MetadataElement(
name="row_graphs_names",
desc="row_graphs_names",
default=[],
param=metadata.SelectParameter,
multiple=True,
readonly=True,
)
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
with h5py.File(filename, "r", locking=False) as loom_file:
# Check the optional but distinctive LOOM_SPEC_VERSION attribute
if bool(loom_file.attrs.get("LOOM_SPEC_VERSION")):
return True
# Check some mandatory H5 datasets and groups
for el in ("matrix", "row_attrs", "col_attrs"):
if loom_file.get(el) is None:
return False
else:
return True
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary Loom file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary Loom file ({nice_size(dataset.get_size())})"
[docs]class Anndata(H5):
"""
Class describing an HDF5 anndata files: http://anndata.rtfd.io
>>> from galaxy.datatypes.sniff import get_test_fname
>>> Anndata().sniff(get_test_fname('pbmc3k_tiny.h5ad'))
True
>>> Anndata().sniff(get_test_fname('test.mz5'))
False
>>> Anndata().sniff(get_test_fname('import.loom.krumsiek11.h5ad'))
True
>>> Anndata().sniff(get_test_fname('adata_0_6_small2.h5ad'))
True
>>> Anndata().sniff(get_test_fname('adata_0_6_small.h5ad'))
True
>>> Anndata().sniff(get_test_fname('adata_0_7_4_small2.h5ad'))
True
>>> Anndata().sniff(get_test_fname('adata_0_7_4_small.h5ad'))
True
>>> Anndata().sniff(get_test_fname('adata_unk2.h5ad'))
True
>>> Anndata().sniff(get_test_fname('adata_unk.h5ad'))
True
"""
file_ext = "h5ad"
MetadataElement(name="title", default="", desc="title", readonly=True, visible=True, no_value="")
MetadataElement(name="description", default="", desc="description", readonly=True, visible=True, no_value="")
MetadataElement(name="url", default="", desc="url", readonly=True, visible=True, no_value="")
MetadataElement(name="doi", default="", desc="doi", readonly=True, visible=True, no_value="")
MetadataElement(
name="anndata_spec_version", default="", desc="anndata_spec_version", readonly=True, visible=True, no_value=""
)
MetadataElement(name="creation_date", default=None, desc="creation_date", readonly=True, visible=True)
MetadataElement(name="layers_count", default=0, desc="layers_count", readonly=True, visible=True, no_value=0)
MetadataElement(
name="layers_names",
desc="layers_names",
default=[],
param=metadata.SelectParameter,
multiple=True,
readonly=True,
)
MetadataElement(name="row_attrs_count", default=0, desc="row_attrs_count", readonly=True, visible=True, no_value=0)
# obs_names: Cell1, Cell2, Cell3,...
# obs_layers: louvain, leidein, isBcell
# obs_count: number of obs_layers
# obs_size: number of obs_names
MetadataElement(name="obs_names", desc="obs_names", default=[], multiple=True, readonly=True)
MetadataElement(
name="obs_layers", desc="obs_layers", default=[], param=metadata.SelectParameter, multiple=True, readonly=True
)
MetadataElement(name="obs_count", default=0, desc="obs_count", readonly=True, visible=True, no_value=0)
MetadataElement(name="obs_size", default=-1, desc="obs_size", readonly=True, visible=True, no_value=0)
MetadataElement(
name="obsm_layers", desc="obsm_layers", default=[], param=metadata.SelectParameter, multiple=True, readonly=True
)
MetadataElement(name="obsm_count", default=0, desc="obsm_count", readonly=True, visible=True, no_value=0)
MetadataElement(
name="raw_var_layers",
desc="raw_var_layers",
default=[],
param=metadata.SelectParameter,
multiple=True,
readonly=True,
)
MetadataElement(name="raw_var_count", default=0, desc="raw_var_count", readonly=True, visible=True, no_value=0)
MetadataElement(name="raw_var_size", default=0, desc="raw_var_size", readonly=True, visible=True, no_value=0)
MetadataElement(
name="var_layers", desc="var_layers", default=[], param=metadata.SelectParameter, multiple=True, readonly=True
)
MetadataElement(name="var_count", default=0, desc="var_count", readonly=True, visible=True, no_value=0)
MetadataElement(name="var_size", default=-1, desc="var_size", readonly=True, visible=True, no_value=0)
MetadataElement(
name="varm_layers", desc="varm_layers", default=[], param=metadata.SelectParameter, multiple=True, readonly=True
)
MetadataElement(name="varm_count", default=0, desc="varm_count", readonly=True, visible=True, no_value=0)
MetadataElement(
name="uns_layers", desc="uns_layers", default=[], param=metadata.SelectParameter, multiple=True, readonly=True
)
MetadataElement(name="uns_count", default=0, desc="uns_count", readonly=True, visible=True, no_value=0)
MetadataElement(
name="shape",
default=(-1, -1),
desc="shape",
param=metadata.ListParameter,
readonly=True,
visible=True,
no_value=(0, 0),
)
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
try:
with h5py.File(filename, "r", locking=False) as f:
return all(attr in f for attr in ["X", "obs", "var"])
except Exception:
return False
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
tmp = dataset.metadata
def _makelayerstrings(layer, count, names):
"Format the layers."
if layer in tmp.layers_names:
return "\n[%s]: %d %s\n %s" % (
layer,
count,
"layer" if count == 1 else "layers",
", ".join(sorted(names)),
)
return ""
peekstr = "[n_obs x n_vars]\n %d x %d" % tuple(tmp.shape)
peekstr += _makelayerstrings("obs", tmp.obs_count, tmp.obs_layers)
peekstr += _makelayerstrings("var", tmp.var_count, tmp.var_layers)
peekstr += _makelayerstrings("obsm", tmp.obsm_count, tmp.obsm_layers)
peekstr += _makelayerstrings("varm", tmp.varm_count, tmp.varm_layers)
peekstr += _makelayerstrings("uns", tmp.uns_count, tmp.uns_layers)
dataset.peek = peekstr
dataset.blurb = f"Anndata file ({nice_size(dataset.get_size())})"
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary Anndata file ({nice_size(dataset.get_size())})"
[docs]@build_sniff_from_prefix
class Grib(Binary):
"""
Class describing an GRIB file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.grib')
>>> Grib().sniff_prefix(FilePrefix(fname))
True
>>> fname = FilePrefix(get_test_fname('interval.interval'))
>>> Grib().sniff_prefix(fname)
False
"""
file_ext = "grib"
# GRIB not yet in EDAM (work in progress). For now, so set to binary
edam_format = "format_2333"
MetadataElement(
name="grib_edition", default=1, desc="GRIB edition", readonly=True, visible=True, optional=True, no_value=0
)
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = b"GRIB"
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
# The first 4 bytes of any GRIB file are GRIB
try:
if file_prefix.startswith_bytes(self._magic):
tmp = file_prefix.contents_header_bytes[4:8]
_uint8struct = struct.Struct(b">B")
edition = _uint8struct.unpack_from(tmp, 3)[0]
if edition == 1 or edition == 2:
return True
return False
except Exception:
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary GRIB file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary GRIB file ({nice_size(dataset.get_size())})"
def _get_grib_edition(self, filename: str) -> int:
_uint8struct = struct.Struct(b">B")
edition = 0
with open(filename, "rb") as f:
f.seek(4)
tmp = f.read(4)
edition = _uint8struct.unpack_from(tmp, 3)[0]
return edition
[docs]@build_sniff_from_prefix
class GmxBinary(Binary):
"""
Base class for GROMACS binary files - xtc, trr, cpt
"""
magic_number: Optional[int] = None # variables to be overwritten in the child class
file_ext = ""
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
# The first 4 bytes of any GROMACS binary file containing the magic number
return file_prefix.magic_header(">1i") == self.magic_number
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = f"Binary GROMACS {self.file_ext} file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary GROMACS {self.file_ext} trajectory file ({nice_size(dataset.get_size())})"
[docs]class Trr(GmxBinary):
"""
Class describing an trr file from the GROMACS suite
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('md.trr')
>>> Trr().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> Trr().sniff(fname)
False
"""
file_ext = "trr"
magic_number = 1993 # magic number reference: https://github.com/gromacs/gromacs/blob/cec211b2c835ba6e8ea849fb1bf67d7fc19693a4/src/gromacs/fileio/trrio.cpp
[docs]class Cpt(GmxBinary):
"""
Class describing a checkpoint (.cpt) file from the GROMACS suite
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('md.cpt')
>>> Cpt().sniff(fname)
True
>>> fname = get_test_fname('md.trr')
>>> Cpt().sniff(fname)
False
"""
file_ext = "cpt"
magic_number = 171817 # magic number reference: https://github.com/gromacs/gromacs/blob/cec211b2c835ba6e8ea849fb1bf67d7fc19693a4/src/gromacs/fileio/checkpoint.cpp
[docs]class Xtc(GmxBinary):
"""
Class describing an xtc file from the GROMACS suite
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('md.xtc')
>>> Xtc().sniff(fname)
True
>>> fname = get_test_fname('md.trr')
>>> Xtc().sniff(fname)
False
"""
file_ext = "xtc"
magic_number = 1995 # reference: https://github.com/gromacs/gromacs/blob/cec211b2c835ba6e8ea849fb1bf67d7fc19693a4/src/gromacs/fileio/xtcio.cpp
[docs]class Edr(GmxBinary):
"""
Class describing an edr file from the GROMACS suite
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('md.edr')
>>> Edr().sniff(fname)
True
>>> fname = get_test_fname('md.trr')
>>> Edr().sniff(fname)
False
"""
file_ext = "edr"
magic_number = (
-55555
) # reference: https://github.com/gromacs/gromacs/blob/cec211b2c835ba6e8ea849fb1bf67d7fc19693a4/src/gromacs/fileio/enxio.cpp
[docs]class Biom2(H5):
"""
Class describing a biom2 file (http://biom-format.org/documentation/biom_format.html)
"""
MetadataElement(name="id", default=None, desc="table id", readonly=True, visible=True)
MetadataElement(name="format_url", default=None, desc="format-url", readonly=True, visible=True)
MetadataElement(
name="format_version", default=None, desc="format-version (equal to format)", readonly=True, visible=True
)
MetadataElement(name="format", default=None, desc="format (equal to format=version)", readonly=True, visible=True)
MetadataElement(name="type", default=None, desc="table type", readonly=True, visible=True)
MetadataElement(name="generated_by", default=None, desc="generated by", readonly=True, visible=True)
MetadataElement(name="creation_date", default=None, desc="creation date", readonly=True, visible=True)
MetadataElement(
name="nnz",
default=-1,
desc="nnz: The number of non-zero elements in the table",
readonly=True,
visible=True,
no_value=-1,
)
MetadataElement(
name="shape",
default=(),
desc="shape: The number of rows and columns in the dataset",
readonly=True,
visible=True,
no_value=(),
)
file_ext = "biom2"
edam_format = "format_3746"
[docs] def sniff(self, filename: str) -> bool:
"""
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('biom2_sparse_otu_table_hdf5.biom2')
>>> Biom2().sniff(fname)
True
>>> fname = get_test_fname('test.mz5')
>>> Biom2().sniff(fname)
False
>>> fname = get_test_fname('wiggle.wig')
>>> Biom2().sniff(fname)
False
"""
if super().sniff(filename):
with h5py.File(filename, "r", locking=False) as f:
required_fields = {"id", "format-url", "type", "generated-by", "creation-date", "nnz", "shape"}
return required_fields.issubset(f.attrs.keys())
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
lines = ["Biom2 (HDF5) file"]
try:
with h5py.File(dataset.get_file_name(), locking=False) as f:
for k, v in f.attrs.items():
lines.append(f"{k}: {util.unicodify(v)}")
except Exception as e:
log.warning("%s, set_peek Exception: %s", self, util.unicodify(e))
dataset.peek = "\n".join(lines)
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Biom2 (HDF5) file ({nice_size(dataset.get_size())})"
[docs]class Cool(H5):
"""
Class describing the cool format (https://github.com/mirnylab/cooler)
"""
file_ext = "cool"
[docs] def sniff(self, filename: str) -> bool:
"""
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('matrix.cool')
>>> Cool().sniff(fname)
True
>>> fname = get_test_fname('test.mz5')
>>> Cool().sniff(fname)
False
>>> fname = get_test_fname('wiggle.wig')
>>> Cool().sniff(fname)
False
>>> fname = get_test_fname('biom2_sparse_otu_table_hdf5.biom2')
>>> Cool().sniff(fname)
False
"""
MAGIC = "HDF5::Cooler"
URL = "https://github.com/mirnylab/cooler"
if super().sniff(filename):
keys = ["chroms", "bins", "pixels", "indexes"]
with h5py.File(filename, "r", locking=False) as handle:
fmt = util.unicodify(handle.attrs.get("format"))
url = util.unicodify(handle.attrs.get("format-url"))
if fmt == MAGIC or url == URL:
if not all(name in handle.keys() for name in keys):
return False
return True
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Cool (HDF5) file for storing genomic interaction data."
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Cool (HDF5) file ({nice_size(dataset.get_size())})."
[docs]class MCool(H5):
"""
Class describing the multi-resolution cool format (https://github.com/mirnylab/cooler)
"""
file_ext = "mcool"
[docs] def sniff(self, filename: str) -> bool:
"""
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('matrix.mcool')
>>> MCool().sniff(fname)
True
>>> fname = get_test_fname('matrix.cool')
>>> MCool().sniff(fname)
False
>>> fname = get_test_fname('test.mz5')
>>> MCool().sniff(fname)
False
>>> fname = get_test_fname('wiggle.wig')
>>> MCool().sniff(fname)
False
>>> fname = get_test_fname('biom2_sparse_otu_table_hdf5.biom2')
>>> MCool().sniff(fname)
False
"""
MAGIC = "HDF5::Cooler"
URL = "https://github.com/mirnylab/cooler"
if super().sniff(filename):
keys0 = ["resolutions"]
with h5py.File(filename, "r", locking=False) as handle:
if not all(name in handle.keys() for name in keys0):
return False
res0 = next(iter(handle["resolutions"].keys()))
keys = ["chroms", "bins", "pixels", "indexes"]
fmt = util.unicodify(handle["resolutions"][res0].attrs.get("format"))
url = util.unicodify(handle["resolutions"][res0].attrs.get("format-url"))
if fmt == MAGIC or url == URL:
if not all(name in handle["resolutions"][res0].keys() for name in keys):
return False
return True
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Multi-resolution Cool (HDF5) file for storing genomic interaction data."
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"MCool (HDF5) file ({nice_size(dataset.get_size())})."
[docs]class H5MLM(H5):
"""
Machine learning model generated by Galaxy-ML.
"""
file_ext = "h5mlm"
TARGET_URL = "https://github.com/goeckslab/Galaxy-ML"
max_peek_size = 1000 # 1 KB
max_preview_size = 1000000 # 1 MB
# reserved keys
CONFIG = "-model_config-"
HTTP_REPR = "-http_repr-"
HYPERPARAMETER = "-model_hyperparameters-"
REPR = "-repr-"
URL = "-URL-"
MetadataElement(
name="hyper_params",
desc="Hyperparameter File",
param=FileParameter,
file_ext="tabular",
readonly=True,
visible=False,
optional=True,
)
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
keys = [self.CONFIG]
with h5py.File(filename, "r", locking=False) as handle:
if not all(name in handle.keys() for name in keys):
return False
url = util.unicodify(handle.attrs.get(self.URL))
if url == self.TARGET_URL:
return True
return False
[docs] def get_attribute(self, filename: str, attr_key: str) -> str:
try:
with h5py.File(filename, "r", locking=False) as handle:
attr = util.unicodify(handle.attrs.get(attr_key))
return attr
except Exception as e:
log.warning("%s, get_attribute Except: %s", self, e)
return ""
[docs] def get_repr(self, filename: str) -> str:
repr = self.get_attribute(filename, self.REPR)
if len(repr) <= self.max_preview_size:
return repr
else:
return "<p><strong>The model representation is too big to be displayed!</strong></p>"
[docs] def get_html_repr(self, filename: str) -> str:
repr = self.get_attribute(filename, self.HTTP_REPR)
if len(repr) <= self.max_preview_size:
return repr
else:
return "<p><strong>The model diagram is too big to be displayed!</strong></p>"
[docs] def get_config_string(self, filename: str) -> str:
try:
with h5py.File(filename, "r", locking=False) as handle:
config = util.unicodify(handle[self.CONFIG][()])
return config
except Exception as e:
log.warning("%s, get model configuration Except: %s", self, e)
return ""
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
repr = self.get_repr(dataset.get_file_name())
dataset.peek = repr[: self.max_peek_size]
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"HDF5 Model ({nice_size(dataset.get_size())})"
[docs] def display_data(
self,
trans,
dataset: DatasetHasHidProtocol,
preview: bool = False,
filename: Optional[str] = None,
to_ext: Optional[str] = None,
**kwd,
):
headers = kwd.pop("headers", {})
preview = util.string_as_bool(preview)
if to_ext or not preview:
to_ext = to_ext or dataset.extension
return self._serve_raw(dataset, to_ext, headers, **kwd)
out_dict: Dict = {}
try:
with h5py.File(dataset.get_file_name(), "r", locking=False) as handle:
out_dict["Attributes"] = {}
attributes = handle.attrs
for k in set(attributes.keys()) - {self.HTTP_REPR, self.REPR, self.URL}:
out_dict["Attributes"][k] = util.unicodify(attributes.get(k))
except Exception as e:
log.warning(e)
config = self.get_config_string(dataset.get_file_name())
out_dict["Config"] = json.loads(config) if config else ""
out = json.dumps(out_dict, sort_keys=True, indent=2)
out = out[: self.max_preview_size]
repr = self.get_repr(dataset.get_file_name())
html_repr = self.get_html_repr(dataset.get_file_name())
return f"<div>{html_repr}</div><div><pre>{repr}</pre></div><div><pre>{out}</pre></div>", headers
[docs]class LudwigModel(Html):
"""
Composite datatype that encloses multiple files for a Ludwig trained model.
"""
composite_type = "auto_primary_file"
file_ext = "ludwig_model"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self.add_composite_file("model_hyperparameters.json", description="Model hyperparameters", is_binary=False)
self.add_composite_file("model_weights", description="Model weights", is_binary=True)
self.add_composite_file("training_set_metadata.json", description="Training set metadata", is_binary=False)
self.add_composite_file(
"training_progress.json", description="Training progress", is_binary=False, optional=True
)
[docs] def generate_primary_file(self, dataset: HasExtraFilesAndMetadata) -> str:
rval = ["<html><head><title>Ludwig Model Composite Dataset.</title></head><p/>"]
rval.append("<div>This model dataset is composed of the following items:<p/><ul>")
for composite_name, composite_file in self.get_composite_files(dataset=dataset).items():
description = composite_file.get("description")
link_text = f"{composite_name} ({description})" if description else composite_name
opt_text = " (optional)" if composite_file.optional else ""
rval.append(f'<li><a href="{composite_name}" type="text/plain">{link_text}</a>{opt_text}</li>')
rval.append("</ul></div></html>")
return "\n".join(rval)
[docs]class HexrdMaterials(H5):
"""
Class describing a Hexrd Materials file: https://github.com/HEXRD/hexrd
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('hexrd.materials.h5')
>>> HexrdMaterials().sniff(fname)
True
>>> fname = get_test_fname('test.loom')
>>> HexrdMaterials().sniff(fname)
False
"""
file_ext = "hexrd.materials.h5"
edam_format = "format_3590"
MetadataElement(
name="materials", desc="materials", default=[], param=metadata.SelectParameter, multiple=True, readonly=True
)
MetadataElement(
name="SpaceGroupNumber",
default={},
param=DictParameter,
desc="SpaceGroupNumber",
readonly=True,
visible=True,
no_value={},
)
MetadataElement(
name="LatticeParameters",
default={},
param=DictParameter,
desc="LatticeParameters",
readonly=True,
visible=True,
no_value={},
)
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
req = {"AtomData", "Atomtypes", "CrystalSystem", "LatticeParameters"}
with h5py.File(filename, "r", locking=False) as mat_file:
for k in mat_file.keys():
if isinstance(mat_file[k], h5py._hl.group.Group) and set(mat_file[k].keys()) >= req:
return True
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
lines = ["Material SpaceGroup Lattice"]
if dataset.metadata.materials:
for m in dataset.metadata.materials:
try:
lines.append(
f"{m} {dataset.metadata.SpaceGroupNumber[m]} {dataset.metadata.LatticeParameters[m]}"
)
except Exception:
continue
dataset.peek = "\n".join(lines)
dataset.blurb = f"Materials: {' '.join(dataset.metadata.materials)}"
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs]class Scf(Binary):
"""Class describing an scf binary sequence file"""
edam_format = "format_1632"
edam_data = "data_0924"
file_ext = "scf"
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary scf sequence file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary scf sequence file ({nice_size(dataset.get_size())})"
[docs]@build_sniff_from_prefix
class Sff(Binary):
"""Standard Flowgram Format (SFF)"""
edam_format = "format_3284"
edam_data = "data_0924"
file_ext = "sff"
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
# The first 4 bytes of any sff file is '.sff', and the file is binary. For details
# about the format, see http://www.ncbi.nlm.nih.gov/Traces/trace.cgi?cmd=show&f=formats&m=doc&s=format
return file_prefix.startswith_bytes(b".sff")
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary sff file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary sff file ({nice_size(dataset.get_size())})"
[docs]@build_sniff_from_prefix
class BigWig(Binary):
"""
Accessing binary BigWig files from UCSC.
The supplemental info in the paper has the binary details:
http://bioinformatics.oxfordjournals.org/cgi/content/abstract/btq351v1
"""
edam_format = "format_3006"
edam_data = "data_3002"
file_ext = "bigwig"
track_type = "LineTrack"
data_sources = {"data_standalone": "bigwig"}
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = 0x888FFC26
self._name = "BigWig"
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
return file_prefix.magic_header("I") == self._magic
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = f"Binary UCSC {self._name} file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary UCSC {self._name} file ({nice_size(dataset.get_size())})"
[docs]class BigBed(BigWig):
"""BigBed support from UCSC."""
edam_format = "format_3004"
edam_data = "data_3002"
file_ext = "bigbed"
data_sources = {"data_standalone": "bigbed"}
[docs] def __init__(self, **kwd):
Binary.__init__(self, **kwd)
self._magic = 0x8789F2EB
self._name = "BigBed"
[docs]@build_sniff_from_prefix
class TwoBit(Binary):
"""Class describing a TwoBit format nucleotide file"""
edam_format = "format_3009"
edam_data = "data_0848"
file_ext = "twobit"
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
magic = file_prefix.magic_header(">L")
return magic == TWOBIT_MAGIC_NUMBER or magic == TWOBIT_MAGIC_NUMBER_SWAP
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary TwoBit format nucleotide file"
dataset.blurb = nice_size(dataset.get_size())
else:
return super().set_peek(dataset)
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary TwoBit format nucleotide file ({nice_size(dataset.get_size())})"
[docs]@dataproviders.decorators.has_dataproviders
class SQlite(Binary):
"""Class describing a Sqlite database"""
MetadataElement(
name="tables", default=[], param=ListParameter, desc="Database Tables", readonly=True, visible=True, no_value=[]
)
MetadataElement(
name="table_columns",
default={},
param=DictParameter,
desc="Database Table Columns",
readonly=True,
visible=True,
no_value={},
)
MetadataElement(
name="table_row_count",
default={},
param=DictParameter,
desc="Database Table Row Count",
readonly=True,
visible=True,
no_value={},
)
file_ext = "sqlite"
edam_format = "format_3621"
[docs] def sniff(self, filename: str) -> bool:
# The first 16 bytes of any SQLite3 database file is 'SQLite format 3\0', and the file is binary. For details
# about the format, see http://www.sqlite.org/fileformat.html
try:
header = open(filename, "rb").read(16)
if header == b"SQLite format 3\0":
return True
return False
except Exception:
return False
[docs] def sniff_table_names(self, filename: str, table_names: Iterable) -> bool:
# All table names should be in the schema
try:
conn = sqlite.connect(filename)
c = conn.cursor()
tables_query = "SELECT name FROM sqlite_master WHERE type='table' ORDER BY name"
result = c.execute(tables_query).fetchall()
result = [_[0] for _ in result]
for table_name in table_names:
if table_name not in result:
return False
return True
except Exception as e:
log.warning("%s, sniff Exception: %s", self, e)
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "SQLite Database"
lines = ["SQLite Database"]
if dataset.metadata.tables:
for table in dataset.metadata.tables:
try:
lines.append(f"{table} [{dataset.metadata.table_row_count[table]}]")
except Exception:
continue
dataset.peek = "\n".join(lines)
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"SQLite Database ({nice_size(dataset.get_size())})"
[docs] @dataproviders.decorators.dataprovider_factory("sqlite", SQliteDataProvider.settings)
def sqlite_dataprovider(self, dataset: DatasetProtocol, **settings) -> SQliteDataProvider:
dataset_source = DatasetDataProvider(dataset)
return SQliteDataProvider(dataset_source, **settings)
[docs] @dataproviders.decorators.dataprovider_factory("sqlite-table", SQliteDataTableProvider.settings)
def sqlite_datatableprovider(self, dataset: DatasetProtocol, **settings) -> SQliteDataTableProvider:
dataset_source = DatasetDataProvider(dataset)
return SQliteDataTableProvider(dataset_source, **settings)
[docs] @dataproviders.decorators.dataprovider_factory("sqlite-dict", SQliteDataDictProvider.settings)
def sqlite_datadictprovider(self, dataset: DatasetProtocol, **settings) -> SQliteDataDictProvider:
dataset_source = DatasetDataProvider(dataset)
return SQliteDataDictProvider(dataset_source, **settings)
[docs]class GeminiSQLite(SQlite):
"""Class describing a Gemini Sqlite database"""
MetadataElement(
name="gemini_version",
default="0.10.0",
param=MetadataParameter,
desc="Gemini Version",
readonly=True,
visible=True,
no_value="0.10.0",
)
file_ext = "gemini.sqlite"
edam_format = "format_3622"
edam_data = "data_3498"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
table_names = [
"gene_detailed",
"gene_summary",
"resources",
"sample_genotype_counts",
"sample_genotypes",
"samples",
"variant_impacts",
"variants",
"version",
]
return self.sniff_table_names(filename, table_names)
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Gemini SQLite Database, version %s" % (dataset.metadata.gemini_version or UNKNOWN)
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return "Gemini SQLite Database, version %s" % (dataset.metadata.gemini_version or UNKNOWN)
[docs]class ChiraSQLite(SQlite):
"""Class describing a ChiRAViz Sqlite database"""
file_ext = "chira.sqlite"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
self.sniff_table_names(filename, ["Chimeras"])
return False
[docs]class CuffDiffSQlite(SQlite):
"""Class describing a CuffDiff SQLite database"""
MetadataElement(
name="cuffdiff_version",
default="2.2.1",
param=MetadataParameter,
desc="CuffDiff Version",
readonly=True,
visible=True,
no_value="2.2.1",
)
MetadataElement(
name="genes", default=[], param=MetadataParameter, desc="Genes", readonly=True, visible=True, no_value=[]
)
MetadataElement(
name="samples", default=[], param=MetadataParameter, desc="Samples", readonly=True, visible=True, no_value=[]
)
file_ext = "cuffdiff.sqlite"
# TODO: Update this when/if there is a specific EDAM format for CuffDiff SQLite data.
edam_format = "format_3621"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
# These tables should be in any CuffDiff SQLite output.
table_names = ["CDS", "genes", "isoforms", "replicates", "runInfo", "samples", "TSS"]
return self.sniff_table_names(filename, table_names)
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "CuffDiff SQLite Database, version %s" % (dataset.metadata.cuffdiff_version or UNKNOWN)
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return "CuffDiff SQLite Database, version %s" % (dataset.metadata.cuffdiff_version or UNKNOWN)
[docs]class MzSQlite(SQlite):
"""Class describing a Proteomics Sqlite database"""
file_ext = "mz.sqlite"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
table_names = [
"DBSequence",
"Modification",
"Peaks",
"Peptide",
"PeptideEvidence",
"Score",
"SearchDatabase",
"Source",
"SpectraData",
"Spectrum",
"SpectrumIdentification",
]
return self.sniff_table_names(filename, table_names)
return False
[docs]class PQP(SQlite):
"""
Class describing a Peptide query parameters file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.pqp')
>>> PQP().sniff(fname)
True
>>> fname = get_test_fname('test.osw')
>>> PQP().sniff(fname)
False
"""
file_ext = "pqp"
[docs] def sniff(self, filename: str) -> bool:
"""
table definition according to https://github.com/grosenberger/OpenMS/blob/develop/src/openms/source/ANALYSIS/OPENSWATH/TransitionPQPFile.cpp#L264
for now VERSION GENE PEPTIDE_GENE_MAPPING are excluded, since
there is test data wo these tables, see also here https://github.com/OpenMS/OpenMS/issues/4365
"""
if not super().sniff(filename):
return False
table_names = [
"COMPOUND",
"PEPTIDE",
"PEPTIDE_PROTEIN_MAPPING",
"PRECURSOR",
"PRECURSOR_COMPOUND_MAPPING",
"PRECURSOR_PEPTIDE_MAPPING",
"PROTEIN",
"TRANSITION",
"TRANSITION_PEPTIDE_MAPPING",
"TRANSITION_PRECURSOR_MAPPING",
]
osw_table_names = ["FEATURE", "FEATURE_MS1", "FEATURE_MS2", "FEATURE_TRANSITION", "RUN"]
return self.sniff_table_names(filename, table_names) and not self.sniff_table_names(filename, osw_table_names)
[docs]class OSW(SQlite):
"""
Class describing OpenSwath output
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.osw')
>>> OSW().sniff(fname)
True
>>> fname = get_test_fname('test.sqmass')
>>> OSW().sniff(fname)
False
"""
file_ext = "osw"
[docs] def sniff(self, filename: str) -> bool:
# osw seems to be an extension of pqp (few tables are added)
# see also here https://github.com/OpenMS/OpenMS/issues/4365
if not super().sniff(filename):
return False
table_names = [
"COMPOUND",
"PEPTIDE",
"PEPTIDE_PROTEIN_MAPPING",
"PRECURSOR",
"PRECURSOR_COMPOUND_MAPPING",
"PRECURSOR_PEPTIDE_MAPPING",
"PROTEIN",
"TRANSITION",
"TRANSITION_PEPTIDE_MAPPING",
"TRANSITION_PRECURSOR_MAPPING",
"FEATURE",
"FEATURE_MS1",
"FEATURE_MS2",
"FEATURE_TRANSITION",
"RUN",
]
return self.sniff_table_names(filename, table_names)
[docs]class SQmass(SQlite):
"""
Class describing a Sqmass database
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.sqmass')
>>> SQmass().sniff(fname)
True
>>> fname = get_test_fname('test.pqp')
>>> SQmass().sniff(fname)
False
"""
file_ext = "sqmass"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
table_names = ["CHROMATOGRAM", "PRECURSOR", "RUN", "SPECTRUM", "DATA", "PRODUCT", "RUN_EXTRA"]
return self.sniff_table_names(filename, table_names)
return False
[docs]class BlibSQlite(SQlite):
"""Class describing a Proteomics Spectral Library Sqlite database"""
MetadataElement(
name="blib_version",
default="1.8",
param=MetadataParameter,
desc="Blib Version",
readonly=True,
visible=True,
no_value="1.8",
)
file_ext = "blib"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
table_names = [
"IonMobilityTypes",
"LibInfo",
"Modifications",
"RefSpectra",
"RefSpectraPeakAnnotations",
"RefSpectraPeaks",
"ScoreTypes",
"SpectrumSourceFiles",
]
return self.sniff_table_names(filename, table_names)
return False
[docs]class DlibSQlite(SQlite):
"""
Class describing a Proteomics Spectral Library Sqlite database
DLIBs only have the "entries", "metadata", and "peptidetoprotein" tables populated.
ELIBs have the rest of the tables populated too, such as "peptidequants" or "peptidescores".
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.dlib')
>>> DlibSQlite().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> DlibSQlite().sniff(fname)
False
"""
MetadataElement(
name="dlib_version",
default="1.8",
param=MetadataParameter,
desc="Dlib Version",
readonly=True,
visible=True,
no_value="1.8",
)
file_ext = "dlib"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
table_names = ["entries", "metadata", "peptidetoprotein"]
return self.sniff_table_names(filename, table_names)
return False
[docs]class ElibSQlite(SQlite):
"""
Class describing a Proteomics Chromatagram Library Sqlite database
DLIBs only have the "entries", "metadata", and "peptidetoprotein" tables populated.
ELIBs have the rest of the tables populated too, such as "peptidequants" or "peptidescores".
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.elib')
>>> ElibSQlite().sniff(fname)
True
>>> fname = get_test_fname('test.dlib')
>>> ElibSQlite().sniff(fname)
False
"""
MetadataElement(
name="version",
default="0.1.14",
param=MetadataParameter,
desc="Elib Version",
readonly=True,
visible=True,
no_value="0.1.14",
)
file_ext = "elib"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
table_names = [
"entries",
"fragmentquants",
"metadata",
"peptidelocalizations",
"peptidequants",
"peptidescores",
"peptidetoprotein",
"proteinscores",
"retentiontimes",
]
if self.sniff_table_names(filename, table_names):
try:
conn = sqlite.connect(filename)
c = conn.cursor()
row_query = "SELECT count(*) FROM peptidescores"
count = c.execute(row_query).fetchone()[0]
return int(count) > 0
except Exception as e:
log.warning("%s, sniff Exception: %s", self, e)
return False
[docs]class IdpDB(SQlite):
"""
Class describing an IDPicker 3 idpDB (sqlite) database
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.idpdb')
>>> IdpDB().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> IdpDB().sniff(fname)
False
"""
file_ext = "idpdb"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
table_names = [
"About",
"Analysis",
"AnalysisParameter",
"PeptideSpectrumMatch",
"Spectrum",
"SpectrumSource",
]
return self.sniff_table_names(filename, table_names)
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "IDPickerDB SQLite file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"IDPickerDB SQLite file ({nice_size(dataset.get_size())})"
[docs]class GAFASQLite(SQlite):
"""Class describing a GAFA SQLite database"""
MetadataElement(
name="gafa_schema_version",
default="0.3.0",
param=MetadataParameter,
desc="GAFA schema version",
readonly=True,
visible=True,
no_value="0.3.0",
)
file_ext = "gafa.sqlite"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
table_names = frozenset({"gene", "gene_family", "gene_family_member", "meta", "transcript"})
return self.sniff_table_names(filename, table_names)
return False
[docs]class NcbiTaxonomySQlite(SQlite):
"""Class describing the NCBI Taxonomy database stored in SQLite as done by rust-ncbitaxonomy"""
MetadataElement(
name="ncbitaxonomy_schema_version",
default="20200501095116",
param=MetadataParameter,
desc="ncbitaxonomy schema version",
readonly=True,
visible=True,
no_value="20200501095116",
)
MetadataElement(
name="taxon_count",
default=[],
param=MetadataParameter,
desc="Count of taxa in the taxonomy",
readonly=True,
visible=True,
no_value=[],
)
file_ext = "ncbitaxonomy.sqlite"
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
table_names = frozenset({"__diesel_schema_migrations", "taxonomy"})
return self.sniff_table_names(filename, table_names)
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "NCBI Taxonomy SQLite Database, version {} ({} taxons)".format(
getattr(dataset.metadata, "ncbitaxonomy_schema_version", UNKNOWN),
getattr(dataset.metadata, "taxon_count", UNKNOWN),
)
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return "NCBI Taxonomy SQLite Database, version {} ({} taxons)".format(
getattr(dataset.metadata, "ncbitaxonomy_schema_version", UNKNOWN),
getattr(dataset.metadata, "taxon_count", UNKNOWN),
)
[docs]@build_sniff_from_prefix
class Xlsx(Binary):
"""Class for Excel 2007 (xlsx) files"""
file_ext = "xlsx"
compressed = True
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
# Xlsx is compressed in zip format and must not be uncompressed in Galaxy.
return file_prefix.compressed_mime_type == "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
[docs]@build_sniff_from_prefix
class ExcelXls(Binary):
"""Class describing an Excel (xls) file"""
file_ext = "excel.xls"
edam_format = "format_3468"
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
return file_prefix.mime_type == self.get_mime()
[docs] def get_mime(self) -> str:
"""Returns the mime type of the datatype"""
return "application/vnd.ms-excel"
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Microsoft Excel XLS file"
dataset.blurb = data.nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Microsoft Excel XLS file ({data.nice_size(dataset.get_size())})"
[docs]@build_sniff_from_prefix
class Sra(Binary):
"""Sequence Read Archive (SRA) datatype originally from mdshw5/sra-tools-galaxy"""
file_ext = "sra"
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
"""The first 8 bytes of any NCBI sra file is 'NCBI.sra', and the file is binary.
For details about the format, see http://www.ncbi.nlm.nih.gov/books/n/helpsra/SRA_Overview_BK/#SRA_Overview_BK.4_SRA_Data_Structure
"""
return file_prefix.startswith_bytes(b"NCBI.sra")
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary sra file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary sra file ({nice_size(dataset.get_size())})"
[docs]@build_sniff_from_prefix
class RData(CompressedArchive):
"""Generic R Data file datatype implementation, i.e. files generated with R's save or save.img function
see https://www.loc.gov/preservation/digital/formats/fdd/fdd000470.shtml
and https://cran.r-project.org/doc/manuals/r-patched/R-ints.html#Serialization-Formats
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.rdata')
>>> RData().sniff(fname)
True
>>> from galaxy.util.bunch import Bunch
>>> dataset = Bunch()
>>> dataset.metadata = Bunch
>>> dataset.get_file_name = lambda : fname
>>> dataset.has_data = lambda: True
>>> RData().set_meta(dataset)
>>> dataset.metadata.version
'3'
"""
VERSION_2_PREFIX = b"RDX2\nX\n"
VERSION_3_PREFIX = b"RDX3\nX\n"
file_ext = "rdata"
MetadataElement(
name="version",
default=None,
desc="serialisation version",
param=MetadataParameter,
readonly=True,
visible=False,
optional=False,
)
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
return file_prefix.startswith_bytes((self.VERSION_2_PREFIX, self.VERSION_3_PREFIX))
def _parse_rdata_header(self, fh: "FileObjType") -> str:
header = fh.read(7)
if header == self.VERSION_2_PREFIX:
return "2"
elif header == self.VERSION_3_PREFIX:
return "3"
else:
raise ValueError()
[docs]@build_sniff_from_prefix
class RDS(CompressedArchive):
"""
File using a serialized R object generated with R's saveRDS function
see https://cran.r-project.org/doc/manuals/r-patched/R-ints.html#Serialization-Formats
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('int-r3.rds')
>>> RDS().sniff(fname)
True
>>> fname = get_test_fname('int-r4.rds')
>>> RDS().sniff(fname)
True
>>> fname = get_test_fname('int-r3-version2.rds')
>>> RDS().sniff(fname)
True
>>> from galaxy.util.bunch import Bunch
>>> dataset = Bunch()
>>> dataset.metadata = Bunch
>>> dataset.get_file_name = lambda : get_test_fname('int-r4.rds')
>>> dataset.has_data = lambda: True
>>> RDS().set_meta(dataset)
>>> dataset.metadata.version
'3'
>>> dataset.metadata.rversion
'4.1.1'
>>> dataset.metadata.minrversion
'3.5.0'
"""
file_ext = "rds"
MetadataElement(
name="version",
default=None,
desc="serialisation version",
param=MetadataParameter,
readonly=True,
visible=False,
optional=False,
)
MetadataElement(
name="rversion",
default=None,
desc="R version",
param=MetadataParameter,
readonly=True,
visible=False,
optional=False,
)
MetadataElement(
name="minrversion",
default=None,
desc="minimum R version",
param=MetadataParameter,
readonly=False,
visible=True,
optional=False,
)
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
try:
self._parse_rds_header(file_prefix.contents_header_bytes[:14])
except Exception:
return False
return True
def _parse_rds_header(self, header_bytes):
"""
get the header info from a rds file
- starts with b'X\n' or 'A\n'
- then 3 integers (each 4bytes) encoded with base 10, e.g. b"\x00\x03\x06\x03" for version "3.6.3"
- the serialization version (2/3)
- the r version used to generate the file
- the minimum r version needed to read the file
"""
header = header_bytes[:2]
if header == b"X\n":
mode = "X"
elif header == b"A\n":
mode = "A"
else:
raise Exception()
version = header_bytes[2:6]
rversion = header_bytes[6:10]
minrversion = header_bytes[10:14]
version = int("".join(str(_) for _ in version))
if version not in [2, 3]:
raise Exception()
rversion = int("".join(str(_) for _ in rversion))
minrversion = int("".join(str(_) for _ in minrversion))
version = ".".join(str(version))
rversion = ".".join(str(rversion))
minrversion = ".".join(str(minrversion))
return mode, version, rversion, minrversion
[docs]class OxliBinary(Binary):
@staticmethod
def _sniff(filename: str, oxlitype: bytes) -> bool:
try:
with open(filename, "rb") as fileobj:
header = fileobj.read(4)
if header == b"OXLI":
fileobj.read(1) # skip the version number
ftype = fileobj.read(1)
if binascii.hexlify(ftype) == oxlitype:
return True
return False
except OSError:
return False
[docs]class OxliCountGraph(OxliBinary):
"""
OxliCountGraph starts with "OXLI" + one byte version number +
8-bit binary '1'
Test file generated via::
load-into-counting.py --n_tables 1 --max-tablesize 1 \\
oxli_countgraph.oxlicg khmer/tests/test-data/100-reads.fq.bz2
using khmer 2.0
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('sequence.csfasta')
>>> OxliCountGraph().sniff(fname)
False
>>> fname = get_test_fname("oxli_countgraph.oxlicg")
>>> OxliCountGraph().sniff(fname)
True
"""
file_ext = "oxlicg"
[docs] def sniff(self, filename: str) -> bool:
return OxliBinary._sniff(filename, b"01")
[docs]class OxliNodeGraph(OxliBinary):
"""
OxliNodeGraph starts with "OXLI" + one byte version number +
8-bit binary '2'
Test file generated via::
load-graph.py --n_tables 1 --max-tablesize 1 oxli_nodegraph.oxling \\
khmer/tests/test-data/100-reads.fq.bz2
using khmer 2.0
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('sequence.csfasta')
>>> OxliNodeGraph().sniff(fname)
False
>>> fname = get_test_fname("oxli_nodegraph.oxling")
>>> OxliNodeGraph().sniff(fname)
True
"""
file_ext = "oxling"
[docs] def sniff(self, filename: str) -> bool:
return OxliBinary._sniff(filename, b"02")
[docs]class OxliSubset(OxliBinary):
"""
OxliSubset starts with "OXLI" + one byte version number +
8-bit binary '5'
Test file generated via::
load-graph.py -k 20 example tests/test-data/random-20-a.fa;
partition-graph.py example;
mv example.subset.0.pmap oxli_subset.oxliss
using khmer 2.0
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('sequence.csfasta')
>>> OxliSubset().sniff(fname)
False
>>> fname = get_test_fname("oxli_subset.oxliss")
>>> OxliSubset().sniff(fname)
True
"""
file_ext = "oxliss"
[docs] def sniff(self, filename: str) -> bool:
return OxliBinary._sniff(filename, b"05")
[docs]class OxliGraphLabels(OxliBinary):
"""
OxliGraphLabels starts with "OXLI" + one byte version number +
8-bit binary '6'
Test file generated via::
python -c "from khmer import GraphLabels; \\
gl = GraphLabels(20, 1e7, 4); \\
gl.consume_fasta_and_tag_with_labels('tests/test-data/test-labels.fa'); \\
gl.save_labels_and_tags('oxli_graphlabels.oxligl')"
using khmer 2.0
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('sequence.csfasta')
>>> OxliGraphLabels().sniff(fname)
False
>>> fname = get_test_fname("oxli_graphlabels.oxligl")
>>> OxliGraphLabels().sniff(fname)
True
"""
file_ext = "oxligl"
[docs] def sniff(self, filename: str) -> bool:
return OxliBinary._sniff(filename, b"06")
[docs]class PostgresqlArchive(CompressedArchive):
"""
Class describing a Postgresql database packed into a tar archive
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('postgresql_fake.tar.bz2')
>>> PostgresqlArchive().sniff(fname)
True
>>> fname = get_test_fname('test.fast5.tar')
>>> PostgresqlArchive().sniff(fname)
False
"""
MetadataElement(
name="version",
default=None,
param=MetadataParameter,
desc="PostgreSQL database version",
readonly=True,
visible=True,
)
file_ext = "postgresql"
[docs] def set_meta(self, dataset: DatasetProtocol, overwrite: bool = True, **kwd) -> None:
super().set_meta(dataset, overwrite=overwrite, **kwd)
try:
if dataset and tarfile.is_tarfile(dataset.get_file_name()):
with tarfile.open(dataset.get_file_name(), "r") as temptar:
pg_version_file = temptar.extractfile("postgresql/db/PG_VERSION")
if not pg_version_file:
raise Exception("Error setting PostgresqlArchive metadata: PG_VERSION file not found")
dataset.metadata.version = util.unicodify(pg_version_file.read()).strip()
except Exception as e:
log.warning("%s, set_meta Exception: %s", self, util.unicodify(e))
[docs] def sniff(self, filename: str) -> bool:
if filename and tarfile.is_tarfile(filename):
with tarfile.open(filename, "r") as temptar:
return "postgresql/db/PG_VERSION" in temptar.getnames()
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = f"PostgreSQL Archive ({nice_size(dataset.get_size())})"
dataset.blurb = "PostgreSQL version %s" % (dataset.metadata.version or UNKNOWN)
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"PostgreSQL Archive ({nice_size(dataset.get_size())})"
[docs]class MongoDBArchive(CompressedArchive):
"""
Class describing a Mongo database packed into a tar archive
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('mongodb_fake.tar.bz2')
>>> MongoDBArchive().sniff(fname)
True
>>> fname = get_test_fname('test.fast5.tar')
>>> MongoDBArchive().sniff(fname)
False
"""
MetadataElement(
name="version",
default=None,
param=MetadataParameter,
desc="MongoDB database version",
readonly=True,
visible=True,
)
file_ext = "mongodb"
[docs] def sniff(self, filename: str) -> bool:
if filename and tarfile.is_tarfile(filename):
with tarfile.open(filename, "r") as temptar:
return "mongo_db/_mdb_catalog.wt" in temptar.getnames()
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = f"MongoDB Archive ({nice_size(dataset.get_size())})"
dataset.blurb = f'MongoDB version {dataset.metadata.version or "unknown"}'
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"MongoDB Archive ({nice_size(dataset.get_size())})"
[docs]class GeneNoteBook(MongoDBArchive):
"""
Class describing a bzip2-compressed GeneNoteBook archive
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('mongodb_fake.tar.bz2')
>>> GeneNoteBook().sniff(fname)
True
>>> fname = get_test_fname('test.fast5.tar.gz')
>>> GeneNoteBook().sniff(fname)
False
"""
file_ext = "genenotebook"
[docs]class Fast5Archive(CompressedArchive):
"""
Class describing a FAST5 archive
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.fast5.tar')
>>> Fast5Archive().sniff(fname)
True
"""
MetadataElement(
name="fast5_count", default="0", param=MetadataParameter, desc="Read Count", readonly=True, visible=True
)
file_ext = "fast5.tar"
[docs] def sniff(self, filename: str) -> bool:
try:
if filename and tarfile.is_tarfile(filename):
with tarfile.open(filename, "r") as temptar:
for f in temptar:
if not f.isfile():
continue
if f.name.endswith(".fast5"):
return True
else:
return False
except Exception as e:
log.warning("%s, sniff Exception: %s", self, e)
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = f"FAST5 Archive ({nice_size(dataset.get_size())})"
dataset.blurb = "%s sequences" % (dataset.metadata.fast5_count or UNKNOWN)
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"FAST5 Archive ({nice_size(dataset.get_size())})"
[docs]class Fast5ArchiveGz(Fast5Archive):
"""
Class describing a gzip-compressed FAST5 archive
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.fast5.tar.gz')
>>> Fast5ArchiveGz().sniff(fname)
True
>>> fname = get_test_fname('test.fast5.tar.xz')
>>> Fast5ArchiveGz().sniff(fname)
False
>>> fname = get_test_fname('test.fast5.tar.bz2')
>>> Fast5ArchiveGz().sniff(fname)
False
>>> fname = get_test_fname('test.fast5.tar')
>>> Fast5ArchiveGz().sniff(fname)
False
"""
file_ext = "fast5.tar.gz"
[docs] def sniff(self, filename: str) -> bool:
if not is_gzip(filename):
return False
return Fast5Archive.sniff(self, filename)
[docs]class Fast5ArchiveXz(Fast5Archive):
"""
Class describing a xz-compressed FAST5 archive
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.fast5.tar.gz')
>>> Fast5ArchiveXz().sniff(fname)
False
>>> fname = get_test_fname('test.fast5.tar.xz')
>>> Fast5ArchiveXz().sniff(fname)
True
>>> fname = get_test_fname('test.fast5.tar.bz2')
>>> Fast5ArchiveXz().sniff(fname)
False
>>> fname = get_test_fname('test.fast5.tar')
>>> Fast5ArchiveXz().sniff(fname)
False
"""
file_ext = "fast5.tar.xz"
[docs] def sniff(self, filename: str) -> bool:
if not is_xz(filename):
return False
return Fast5Archive.sniff(self, filename)
[docs]class Fast5ArchiveBz2(Fast5Archive):
"""
Class describing a bzip2-compressed FAST5 archive
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.fast5.tar.bz2')
>>> Fast5ArchiveBz2().sniff(fname)
True
>>> fname = get_test_fname('test.fast5.tar.xz')
>>> Fast5ArchiveBz2().sniff(fname)
False
>>> fname = get_test_fname('test.fast5.tar.gz')
>>> Fast5ArchiveBz2().sniff(fname)
False
>>> fname = get_test_fname('test.fast5.tar')
>>> Fast5ArchiveBz2().sniff(fname)
False
"""
file_ext = "fast5.tar.bz2"
[docs] def sniff(self, filename: str) -> bool:
if not is_bz2(filename):
return False
return Fast5Archive.sniff(self, filename)
[docs]class Pod5(Binary):
"""
Class describing a POD5 file. The POD5 Format Specification is at
https://pod5-file-format.readthedocs.io/en/latest/SPECIFICATION.html
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.pod5')
>>> Pod5().sniff(fname)
True
>>> fname = get_test_fname('test.fast5.tar')
>>> Pod5().sniff(fname)
False
"""
file_ext = "pod5"
[docs] def sniff(self, filename: str) -> bool:
expected_signature = bytes([0x8B, 0x50, 0x4F, 0x44, 0x0D, 0x0A, 0x1A, 0x0A])
with open(filename, "rb") as f:
first_8_bytes = f.read(8)
f.seek(-8, 2)
last_8_bytes = f.read(8)
return first_8_bytes == expected_signature and last_8_bytes == expected_signature
[docs]class SearchGuiArchive(CompressedArchive):
"""Class describing a SearchGUI archive"""
MetadataElement(
name="searchgui_version",
default="1.28.0",
param=MetadataParameter,
desc="SearchGui Version",
readonly=True,
visible=True,
)
MetadataElement(
name="searchgui_major_version",
default="1",
param=MetadataParameter,
desc="SearchGui Major Version",
readonly=True,
visible=True,
)
file_ext = "searchgui_archive"
[docs] def sniff(self, filename: str) -> bool:
try:
if filename and zipfile.is_zipfile(filename):
with zipfile.ZipFile(filename, "r") as tempzip:
is_searchgui = "searchgui.properties" in tempzip.namelist()
return is_searchgui
except Exception as e:
log.warning("%s, sniff Exception: %s", self, e)
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "SearchGUI Archive, version %s" % (dataset.metadata.searchgui_version or UNKNOWN)
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return "SearchGUI Archive, version %s" % (dataset.metadata.searchgui_version or UNKNOWN)
[docs]@build_sniff_from_prefix
class NetCDF(Binary):
"""Binary data in netCDF format"""
file_ext = "netcdf"
edam_format = "format_3650"
edam_data = "data_0943"
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary netCDF file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary netCDF file ({nice_size(dataset.get_size())})"
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
return file_prefix.startswith_bytes(b"CDF")
[docs]class Dcd(Binary):
"""
Class describing a dcd file from the CHARMM molecular simulation program
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test_glucose_vacuum.dcd')
>>> Dcd().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> Dcd().sniff(fname)
False
"""
file_ext = "dcd"
edam_data = "data_3842"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic_number = b"CORD"
[docs] def sniff(self, filename: str) -> bool:
# Match the keyword 'CORD' at position 4 or 8 - intsize dependent
# Not checking for endianness
try:
with open(filename, "rb") as header:
intsize = 4
header.seek(intsize)
if header.read(intsize) == self._magic_number:
return True
else:
intsize = 8
header.seek(intsize)
if header.read(intsize) == self._magic_number:
return True
return False
except Exception:
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary CHARMM/NAMD dcd file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary CHARMM/NAMD dcd file ({nice_size(dataset.get_size())})"
[docs]class Vel(Binary):
"""
Class describing a velocity file from the CHARMM molecular simulation program
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test_charmm.vel')
>>> Vel().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> Vel().sniff(fname)
False
"""
file_ext = "vel"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic_number = b"VELD"
[docs] def sniff(self, filename: str) -> bool:
# Match the keyword 'VELD' at position 4 or 8 - intsize dependent
# Not checking for endianness
try:
with open(filename, "rb") as header:
intsize = 4
header.seek(intsize)
if header.read(intsize) == self._magic_number:
return True
else:
intsize = 8
header.seek(intsize)
if header.read(intsize) == self._magic_number:
return True
return False
except Exception:
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary CHARMM velocity file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary CHARMM velocity file ({nice_size(dataset.get_size())})"
[docs]@build_sniff_from_prefix
class DAA(Binary):
"""
Class describing an DAA (diamond alignment archive) file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('diamond.daa')
>>> DAA().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> DAA().sniff(fname)
False
"""
file_ext = "daa"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = binascii.unhexlify("6be33e6d47530e3c")
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
# The first 8 bytes of any daa file are 0x3c0e53476d3ee36b
return file_prefix.startswith_bytes(self._magic)
[docs]@build_sniff_from_prefix
class RMA6(Binary):
"""
Class describing an RMA6 (MEGAN6 read-match archive) file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('diamond.rma6')
>>> RMA6().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> RMA6().sniff(fname)
False
"""
file_ext = "rma6"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = binascii.unhexlify("000003f600000006")
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
return file_prefix.startswith_bytes(self._magic)
[docs]@build_sniff_from_prefix
class DMND(Binary):
"""
Class describing an DMND file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('diamond_db.dmnd')
>>> DMND().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> DMND().sniff(fname)
False
"""
file_ext = "dmnd"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = binascii.unhexlify("6d18ee15a4f84a02")
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
# The first 8 bytes of any dmnd file are 0x24af8a415ee186d
return file_prefix.startswith_bytes(self._magic)
[docs]class ICM(Binary):
"""
Class describing an ICM (interpolated context model) file, used by Glimmer
"""
file_ext = "icm"
edam_data = "data_0950"
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary ICM (interpolated context model) file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def sniff(self, filename: str) -> bool:
line = open(filename).read(100)
if (
">ver = " in line
and "len = " in line
and "depth = " in line
and "periodicity =" in line
and "nodes = " in line
):
return True
return False
[docs]@build_sniff_from_prefix
class Parquet(Binary):
"""
Class describing Apache Parquet file (https://parquet.apache.org/)
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('example.parquet')
>>> Parquet().sniff(fname)
True
>>> fname = get_test_fname('test.mz5')
>>> Parquet().sniff(fname)
False
"""
file_ext = "parquet"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = b"PAR1" # Defined at https://parquet.apache.org/documentation/latest/
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
return file_prefix.startswith_bytes(self._magic)
[docs]class BafTar(CompressedArchive):
"""
Base class for common behavior of tar files of directory-based raw file formats
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('brukerbaf.d.tar')
>>> BafTar().sniff(fname)
True
>>> fname = get_test_fname('test.fast5.tar')
>>> BafTar().sniff(fname)
False
"""
edam_data = "data_2536" # mass spectrometry data
edam_format = "format_3712" # TODO: add more raw formats to EDAM?
file_ext = "brukerbaf.d.tar"
[docs] def get_signature_file(self) -> str:
return "analysis.baf"
[docs] def sniff(self, filename: str) -> bool:
if tarfile.is_tarfile(filename):
with tarfile.open(filename) as rawtar:
return self.get_signature_file() in [os.path.basename(f).lower() for f in rawtar.getnames()]
return False
[docs] def get_type(self) -> str:
return "Bruker BAF directory archive"
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = self.get_type()
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"{self.get_type()} ({nice_size(dataset.get_size())})"
[docs]class YepTar(BafTar):
"""A tar'd up .d directory containing Agilent/Bruker YEP format data"""
file_ext = "agilentbrukeryep.d.tar"
[docs] def get_signature_file(self) -> str:
return "analysis.yep"
[docs] def get_type(self) -> str:
return "Agilent/Bruker YEP directory archive"
[docs]class TdfTar(BafTar):
"""A tar'd up .d directory containing Bruker TDF format data"""
file_ext = "brukertdf.d.tar"
[docs] def get_signature_file(self) -> str:
return "analysis.tdf"
[docs] def get_type(self) -> str:
return "Bruker TDF directory archive"
[docs]class MassHunterTar(BafTar):
"""A tar'd up .d directory containing Agilent MassHunter format data"""
file_ext = "agilentmasshunter.d.tar"
[docs] def get_signature_file(self) -> str:
return "msscan.bin"
[docs] def get_type(self) -> str:
return "Agilent MassHunter directory archive"
[docs]class MassLynxTar(BafTar):
"""A tar'd up .d directory containing Waters MassLynx format data"""
file_ext = "watersmasslynx.raw.tar"
[docs] def get_signature_file(self) -> str:
return "_func001.dat"
[docs] def get_type(self) -> str:
return "Waters MassLynx RAW directory archive"
[docs]class WiffTar(BafTar):
"""
A tar'd up .wiff/.scan pair containing Sciex WIFF format data
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('some.wiff.tar')
>>> WiffTar().sniff(fname)
True
>>> fname = get_test_fname('brukerbaf.d.tar')
>>> WiffTar().sniff(fname)
False
>>> fname = get_test_fname('test.fast5.tar')
>>> WiffTar().sniff(fname)
False
"""
file_ext = "wiff.tar"
[docs] def sniff(self, filename: str) -> bool:
if tarfile.is_tarfile(filename):
with tarfile.open(filename) as rawtar:
return ".wiff" in [os.path.splitext(os.path.basename(f).lower())[1] for f in rawtar.getnames()]
return False
[docs] def get_type(self) -> str:
return "Sciex WIFF/SCAN archive"
[docs]class Wiff2Tar(BafTar):
"""
A tar'd up .wiff2/.scan pair containing Sciex WIFF format data
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('some.wiff2.tar')
>>> Wiff2Tar().sniff(fname)
True
>>> fname = get_test_fname('brukerbaf.d.tar')
>>> Wiff2Tar().sniff(fname)
False
>>> fname = get_test_fname('test.fast5.tar')
>>> Wiff2Tar().sniff(fname)
False
"""
file_ext = "wiff2.tar"
[docs] def sniff(self, filename: str) -> bool:
if tarfile.is_tarfile(filename):
with tarfile.open(filename) as rawtar:
return ".wiff2" in [os.path.splitext(os.path.basename(f).lower())[1] for f in rawtar.getnames()]
return False
[docs] def get_type(self) -> str:
return "Sciex WIFF2/SCAN archive"
[docs]@build_sniff_from_prefix
class Pretext(Binary):
"""
PretextMap contact map file
Try to guess if the file is a Pretext file.
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('sample.pretext')
>>> Pretext().sniff(fname)
True
"""
file_ext = "pretext"
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
# The first 4 bytes of any pretext file is 'pstm', and the rest of the
# file contains binary data.
return file_prefix.startswith_bytes(b"pstm")
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary pretext file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary pretext file ({nice_size(dataset.get_size())})"
[docs]class JP2(Binary):
"""
JPEG 2000 binary image format
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.jp2')
>>> JP2().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> JP2().sniff(fname)
False
"""
file_ext = "jp2"
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = binascii.unhexlify("0000000C6A5020200D0A870A")
[docs] def sniff(self, filename: str) -> bool:
# The first 12 bytes of any jp2 file are 0000000C6A5020200D0A870A
try:
header = open(filename, "rb").read(12)
if header == self._magic:
return True
return False
except Exception:
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "Binary JPEG 2000 file"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary JPEG 2000 file ({nice_size(dataset.get_size())})"
[docs]class Npz(CompressedArchive):
"""
Class describing an Numpy NPZ file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('hexrd.images.npz')
>>> Npz().sniff(fname)
True
>>> fname = get_test_fname('interval.interval')
>>> Npz().sniff(fname)
False
"""
file_ext = "npz"
# edam_format = "format_4003"
MetadataElement(name="nfiles", default=0, desc="nfiles", readonly=True, visible=True, no_value=0)
MetadataElement(name="files", default=[], desc="files", readonly=True, visible=True, no_value=[])
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
[docs] def sniff(self, filename: str) -> bool:
try:
with np.load(filename) as npz:
if isinstance(npz, np.lib.npyio.NpzFile) and any(f.filename.endswith(".npy") for f in npz.zip.filelist):
return True
except Exception:
return False
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = f"Binary Numpy npz {dataset.metadata.nfiles} files ({nice_size(dataset.get_size())})"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary Numpy npz file ({nice_size(dataset.get_size())})"
[docs]class HexrdImagesNpz(Npz):
"""
Class describing an HEXRD Images Numpy NPZ file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('hexrd.images.npz')
>>> HexrdImagesNpz().sniff(fname)
True
>>> fname = get_test_fname('hexrd.eta_ome.npz')
>>> HexrdImagesNpz().sniff(fname)
False
"""
file_ext = "hexrd.images.npz"
MetadataElement(
name="panel_id",
default="",
desc="Detector Panel ID",
param=MetadataParameter,
readonly=True,
visible=True,
optional=True,
no_value="",
)
MetadataElement(
name="shape", default=(), desc="shape", param=metadata.ListParameter, readonly=True, visible=True, no_value=()
)
MetadataElement(name="nframes", default=0, desc="nframes", readonly=True, visible=True, no_value=0)
MetadataElement(name="omegas", desc="has omegas", default="False", visible=False)
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
try:
req_files = {"0_row", "0_col", "0_data", "shape", "nframes", "dtype"}
with np.load(filename) as npz:
return set(npz.files) >= req_files
except Exception as e:
log.warning("%s, sniff Exception: %s", self, e)
return False
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
lines = [
f"Binary Hexrd Image npz {dataset.metadata.nfiles} files ({nice_size(dataset.get_size())})",
f"Panel: {dataset.metadata.panel_id} Frames: {dataset.metadata.nframes} Shape: {dataset.metadata.shape}",
]
dataset.peek = "\n".join(lines)
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary Numpy npz file ({nice_size(dataset.get_size())})"
[docs]class HexrdEtaOmeNpz(Npz):
"""
Class describing an HEXRD Eta-Ome Numpy NPZ file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('hexrd.eta_ome.npz')
>>> HexrdEtaOmeNpz().sniff(fname)
True
>>> fname = get_test_fname('hexrd.images.npz')
>>> HexrdEtaOmeNpz().sniff(fname)
False
"""
file_ext = "hexrd.eta_ome.npz"
MetadataElement(
name="HKLs", default=(), desc="HKLs", param=metadata.ListParameter, readonly=True, visible=True, no_value=()
)
MetadataElement(name="nframes", default=0, desc="nframes", readonly=True, visible=True, no_value=0)
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
[docs] def sniff(self, filename: str) -> bool:
if super().sniff(filename):
try:
req_files = {"dataStore", "etas", "etaEdges", "iHKLList", "omegas", "omeEdges", "planeData_hkls"}
with np.load(filename) as npz:
return set(npz.files) >= req_files
except Exception as e:
log.warning("%s, sniff Exception: %s", self, e)
return False
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
lines = [
f"Binary Hexrd Eta-Ome npz {dataset.metadata.nfiles} files ({nice_size(dataset.get_size())})",
f"Eta-Ome HKLs: {dataset.metadata.HKLs} Frames: {dataset.metadata.nframes}",
]
dataset.peek = "\n".join(lines)
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary Numpy npz file ({nice_size(dataset.get_size())})"
[docs]class FITS(Binary):
"""
FITS (Flexible Image Transport System) file data format, widely used in astronomy
Represents sky images (in celestial coordinates) and tables
https://fits.gsfc.nasa.gov/fits_primer.html
"""
file_ext = "fits"
MetadataElement(
name="HDUs",
default=["FITS File HDUs"],
desc="Header Data Units",
param=metadata.ListParameter,
readonly=True,
visible=True,
no_value=(),
)
[docs] def __init__(self, **kwd):
super().__init__(**kwd)
self._magic = b"SIMPLE ="
[docs] def sniff(self, filename: str) -> bool:
"""
Determines whether the file is a FITS file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.fits')
>>> FITS().sniff(fname)
True
>>> fname = FilePrefix(get_test_fname('interval.interval'))
>>> FITS().sniff(fname)
False
"""
try:
# The first 9 bytes of any FITS file are always "SIMPLE ="
with open(filename, "rb") as header:
if header.read(9) == self._magic:
return True
return False
except Exception as e:
log.warning("%s, sniff Exception: %s", self, e)
return False
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = "\n".join(dataset.metadata.HDUs)
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary FITS file size ({nice_size(dataset.get_size())})"
[docs]@build_sniff_from_prefix
class Numpy(Binary):
"""
Class defining a numpy data file
>>> from galaxy.datatypes.sniff import get_test_fname
>>> fname = get_test_fname('test.npy')
>>> Numpy().sniff(fname)
True
"""
file_ext = "npy"
MetadataElement(
name="version_str",
default="",
param=MetadataParameter,
desc="Version string for the numpy file format",
readonly=True,
visible=True,
no_value=0,
optional=True,
)
def _numpy_version_string(self, filename):
magic_string = open(filename, "rb").read(8)
version_str = f"{magic_string[6]}.{magic_string[7]}"
return version_str
[docs] def sniff_prefix(self, file_prefix: FilePrefix) -> bool:
# The first 6 bytes of any numpy file is '\x93NUMPY', with following bytes for version
# number of file formats, and info about header data. The rest of the file contains binary data.
return file_prefix.startswith_bytes(b"\x93NUMPY")
[docs] def set_peek(self, dataset: DatasetProtocol, **kwd) -> None:
if not dataset.dataset.purged:
dataset.peek = f"Binary numpy file version {dataset.metadata.version_str}"
dataset.blurb = nice_size(dataset.get_size())
else:
dataset.peek = "file does not exist"
dataset.blurb = "file purged from disk"
[docs] def display_peek(self, dataset: DatasetProtocol) -> str:
try:
return dataset.peek
except Exception:
return f"Binary numpy file ({nice_size(dataset.get_size())})"