Acquire.Client._filehandle module

class FileHandle(filename=None, remote_filename=None, aclrules=None, drive_uid=None, user_guid=None, compress=True)

Bases: object

This class holds all of the information about a file that is held in a Drive, including its size and checksum, and information about previous versions. It provides a handle that you can use to download or delete the file, to upload new versions, or to move the data between hot and cold storage or pay for extended storage

aclrules()

Return the ACL rules for this file

checksum()

Return the checksum of the contents of this file

compression_type()

Return a string describing the compression scheme used by the filehandle when transporting the file, or None if the data is not compressed

drive_uid()

Return the UID of the drive on which this file is located

filename()

Return the remote (object store) filename for this file

filesize()

Return the size (in bytes) of this file

fingerprint()

Return a fingerprint for this file

static from_data(data)

Return an object created from the passed json-deserialised dictionary. Note that this does not contain any information about the local file itself - just the name it should be called on the object store and the size, checksum and acl. If the file (or compressed file) is sufficiently small then this will also contain the packed version of that file data

is_compressed()

Return whether or not the file is compressed on transport

is_localdata()

Return whether or not this file is so small that the data is held in memory

is_null()

Return whether or not this this null

local_filedata(uncompress=False)

Return the filedata for this file, assuming it is sufficiently small to be read in this way. Returns ‘None’ if not…

If ‘uncompress’ is true, then uncompress the data (if it is compressed) before returning

local_filename()

Return the local filename for this file

to_data()

Return a json-serialisable dictionary for this object. Note that this does not contain any information about the local file itself - just the name it should be called on the object store and the size, checksum and acl. If the file (or compressed file) is sufficiently small then this will also contain the packed version of that file data

user_guid()

Return the GUID of the user who has opened/uploaded this file