forked from appium/python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathremote_fs.py
More file actions
96 lines (76 loc) · 3.5 KB
/
remote_fs.py
File metadata and controls
96 lines (76 loc) · 3.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
#!/usr/bin/env python
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import base64
from typing import Optional, TypeVar
from selenium import webdriver
from selenium.common.exceptions import InvalidArgumentException
from ..mobilecommand import MobileCommand as Command
T = TypeVar('T', bound='RemoteFS')
class RemoteFS(webdriver.Remote):
def pull_file(self, path: str) -> str:
"""Retrieves the file at `path`.
Args:
path (str): the path to the file on the device
Returns:
str: The file's contents encoded as Base64.
"""
data = {
'path': path,
}
return self.execute(Command.PULL_FILE, data)['value']
def pull_folder(self, path: str) -> str:
"""Retrieves a folder at `path`.
Args:
path (str): the path to the folder on the device
Returns:
str: The folder's contents zipped and encoded as Base64.
"""
data = {
'path': path,
}
return self.execute(Command.PULL_FOLDER, data)['value']
def push_file(self, destination_path: str,
base64data: Optional[str] = None, source_path: Optional[str] = None) -> T:
"""Puts the data from the file at `source_path`, encoded as Base64, in the file specified as `path`.
Specify either `base64data` or `source_path`, if both specified default to `source_path`
Args:
destination_path (str): the location on the device/simulator where the local file contents should be saved
base64data (:obj:`str`, optional): file contents, encoded as Base64, to be written to the file on the device/simulator
source_path (:obj:`str`, optional): local file path for the file to be loaded on device
Returns:
`appium.webdriver.webdriver.WebDriver`
"""
if source_path is None and base64data is None:
raise InvalidArgumentException('Must either pass base64 data or a local file path')
if source_path is not None:
try:
with open(source_path, 'rb') as f:
file_data = f.read()
except IOError as e:
message = f'source_path "{source_path}" could not be found. Are you sure the file exists?'
raise InvalidArgumentException(message) from e
base64data = base64.b64encode(file_data).decode('utf-8')
data = {
'path': destination_path,
'data': base64data,
}
self.execute(Command.PUSH_FILE, data)
return self
# pylint: disable=protected-access
def _addCommands(self) -> None:
self.command_executor._commands[Command.PULL_FILE] = \
('POST', '/session/$sessionId/appium/device/pull_file')
self.command_executor._commands[Command.PULL_FOLDER] = \
('POST', '/session/$sessionId/appium/device/pull_folder')
self.command_executor._commands[Command.PUSH_FILE] = \
('POST', '/session/$sessionId/appium/device/push_file')