blob: 4d0c7adb5ca0b2c8ec902293525e3979a22f991a [file] [log] [blame]
# Copyright 2013 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""A temp file that automatically gets pushed and deleted from a device."""
# pylint: disable=W0622
import posixpath
import random
import threading
from import device_errors
from devil.utils import cmd_helper
class DeviceTempFile(object):
def __init__(self, adb, suffix='', prefix='temp_file', dir='/data/local/tmp'):
"""Find an unused temporary file path on the device.
When this object is closed, the file will be deleted on the device.
adb: An instance of AdbWrapper
suffix: The suffix of the name of the temp file.
prefix: The prefix of the name of the temp file.
dir: The directory on the device where to place the temp file.
ValueError if any of suffix, prefix, or dir are None.
if None in (dir, prefix, suffix):
m = 'Provided None path component. (dir: %s, prefix: %s, suffix: %s)' % (
dir, prefix, suffix)
raise ValueError(m)
self._adb = adb
# Python's random module use 52-bit numbers according to its docs.
random_hex = hex(random.randint(0, 2 ** 52))[2:] = posixpath.join(dir, '%s-%s%s' % (prefix, random_hex, suffix))
self.name_quoted = cmd_helper.SingleQuote(
def close(self):
"""Deletes the temporary file from the device."""
# ignore exception if the file is already gone.
def delete_temporary_file():
self._adb.Shell('rm -f %s' % self.name_quoted, expect_status=None)
except device_errors.AdbCommandFailedError:
# file does not exist on Android version without 'rm -f' support (ICS)
# It shouldn't matter when the temp file gets deleted, so do so
# asynchronously.
name='delete_temporary_file(%s)' % self._adb.GetDeviceSerial()).start()
def __enter__(self):
return self
def __exit__(self, type, value, traceback):