Add screenshot number count support

- Add snapshot (using helper take screenshot)
- Add screenshot number to default filename template
- Temporary substitute device template for helper

Author: dtmilano

src/com/dtmilano/android/adb/adbclient.py

@@ -27,7 +27,7 @@
 
 from com.dtmilano.android.adb.dumpsys import Dumpsys
 
-__version__ = '21.11.1'
+__version__ = '21.11.2'
 
 import sys
 import warnings
@@ -226,6 +226,9 @@ def __init__(self, serialno=None, hostname=HOSTNAME, port=PORT, settransport=Tru
         self.display = {}
         ''' The map containing the device's physical display properties: width, height and density '''
 
+        self.screenshot_number = 1
+        ''' The screenshot number count '''
+
         self.isTransportSet = False
         if settransport and serialno is not None:
             self.__setTransport(timeout=timeout)
@@ -932,6 +935,7 @@ def takeSnapshot(self, reconnect=False):
 
         if PROFILE:
             profileEnd()
+        self.screenshot_number += 1
         return image
 
     def imageToData(self, image, output_type=None):
@@ -1428,6 +1432,7 @@ def substituteDeviceTemplate(self, template):
         if osName.startswith('Windows'):  # ':' not supported in filenames
             timestamp.replace(':', '_')
         _map = {
+            'screenshot_number': f'{self.screenshot_number:04d}',
             'serialno': serialno,
             'focusedwindowname': focusedWindowName,
             'timestamp': timestamp

src/com/dtmilano/android/culebron.py

@@ -34,7 +34,7 @@
 from com.dtmilano.android.keyevent import KEY_EVENT
 from com.dtmilano.android.viewclient import ViewClient, View
 
-__version__ = '21.11.1'
+__version__ = '21.11.2'
 
 import sys
 import threading
@@ -142,6 +142,7 @@ class Operation:
     SAY_TEXT = 'say_text'
     SET_TEXT = 'set_text'
     SNAPSHOT = 'snapshot'
+    SNAPSHOT_UI_AUTOMATOR_HELPER = 'snapshot_ui_automator_helper'
     START_ACTIVITY = 'start_activity'
     START_ACTIVITY_UI_AUTOMATOR_HELPER = 'start_activity_ui_automator__helper'
     SLEEP = 'sleep'
@@ -1167,14 +1168,26 @@ def saveSnapshot(self):
         Current snapshot is the image being displayed on the main window.
         '''
 
-        filename = self.snapshotDir + os.sep + '${serialno}-${focusedwindowname}-${timestamp}' + '.' + self.snapshotFormat.lower()
+        filename = self.snapshotDir + os.sep + '${serialno}-${screenshot_number}-${focusedwindowname}-${timestamp}' + '.' + self.snapshotFormat.lower()
         # We have the snapshot already taken, no need to retake
         d = FileDialog(self, self.device.substituteDeviceTemplate(filename))
         saveAsFilename = d.askSaveAsFilename()
         if saveAsFilename:
             _format = os.path.splitext(saveAsFilename)[1][1:].upper()
-            self.printOperation(None, Operation.SNAPSHOT, filename, _format, self.deviceArt, self.dropShadow,
+            if self.vc.uiAutomatorHelper:
+                # FIXME: we should use fields in this class instead of relying on device
+                # FIXME: the screenshot name is generated here and then no re-evaluation of variables take place
+                # when the generated script runs (i.e. if the serialno changes then the filenames will be wrong)
+                # Note that in the other case (no helper), the template is re-evaluated.
+                # Then, it may make more sense to have the template evaluation in ui_device.take_screenshot().
+                _filename = self.device.substituteDeviceTemplate(filename)
+                self.printOperation(None, Operation.SNAPSHOT_UI_AUTOMATOR_HELPER, _filename, _format)
+                # FIXME: we increment here as we dont use device.takeSnapshot() which increments the count
+                self.device.screenshot_number += 1
+            else:
+                self.printOperation(None, Operation.SNAPSHOT, filename, _format, self.deviceArt, self.dropShadow,
                                 self.screenGlare)
+
             # FIXME: we should add deviceArt, dropShadow and screenGlare to the saved image
             # self.unscaledScreenshot.save(saveAsFilename, _format, self.deviceArt, self.dropShadow, self.screenGlare)
             self.unscaledScreenshot.save(saveAsFilename, _format)

tools/culebra

@@ -747,6 +747,18 @@ def printTakeSnapshot(filename, _format, deviceart, dropshadow, screenglare):
             indent, prefix, filename, _format, deviceart, dropshadow, screenglare))
 
 
+def printTakeSnapshotUiAutomatorHelper(filename, _format='PNG'):
+    '''
+    Prints the corresponding take_screenshot() to take a snapshot
+    '''
+
+    if options[CulebraOptions.MULTI_DEVICE]:
+        warnings.warn('Multi-device not implemented yet for this case')
+    else:
+        logAction(f'taking screenshot @ {filename} format={_format}')
+        print(f'{indent}{prefix}helper.ui_device.take_screenshot(filename=\'{filename}\')')
+
+
 def traverseAndPrint(view):
     '''
     Traverses the View tree and prints the corresponding statement.
@@ -1085,6 +1097,9 @@ def printOperation(view, op, *args):
     elif op == Operation.SNAPSHOT:
         printTakeSnapshot(filename=args[0], _format=args[1], deviceart=args[2], dropshadow=args[3], screenglare=args[4])
         return
+    elif op == Operation.SNAPSHOT_UI_AUTOMATOR_HELPER:
+        printTakeSnapshotUiAutomatorHelper(filename=args[0], _format=args[1])
+        return
     elif op == Operation.SWIPE_UI_AUTOMATOR_HELPER:
         printSwipeUiAutomatorHelper(startX=args[0], startY=args[1], endX=args[2], endY=args[3], steps=args[4],
                                     unit=args[5], orientation=args[6])