Merge pull request #6 from AndyEveritt/raw

Raw

Author: AndyEveritt

README.md

@@ -34,8 +34,8 @@ Method | Description
 ------ | -----------
 `get_model(key: str = None) -> Dict` | Get Duet object model. RRF3 only
 `send_code(code: str) -> Dict` | Send G/M/T-code to Duet
-`get_file(filename: str, directory: str = 'gcodes') -> str` | Download file from Duet
-`upload_file(file: StringIO \| TextIOWrapper, filename: str, directory: str = 'gcodes') -> Dict` | Upload file to Duet
+`get_file(filename: str, directory: str = 'gcodes', binary: bool = False) -> str` | Download file from Duet
+`upload_file(file: str \| bytes \| StringIO \| TextIOWrapper \| BytesIO, filename: str, directory: str = 'gcodes') -> Dict` | Upload file to Duet
 `get_fileinfo(filename: str = None, directory: str = 'gcodes') -> Dict` | Get file info
 `delete_file(filename: str, directory: str = 'gcodes') -> Dict` | Delete file on Duet
 `move_file(from_path: str, to_path: str, force: bool = False) -> Dict` | Move file on Duet, can be used to rename files

duetwebapi/api/base.py

@@ -37,11 +37,11 @@ def send_code(self, code: str) -> Dict:
         """ Send G/M/T-code to Duet """
         raise NotImplementedError
 
-    def get_file(self, filename: str, directory: str = 'gcodes') -> str:
+    def get_file(self, filename: str, directory: str = 'gcodes', binary: bool = False) -> str:
         """ Get file from Duet """
         raise NotImplementedError
 
-    def upload_file(self, file: Union[StringIO, TextIOWrapper], filename: str, directory: str = 'gcodes') -> Dict:
+    def upload_file(self, file: Union[str, bytes, StringIO, TextIOWrapper, BytesIO], filename: str, directory: str = 'gcodes') -> Dict:
         """ Upload file to Duet """
         raise NotImplementedError
 

duetwebapi/api/dsf_api.py

@@ -28,25 +28,27 @@ def send_code(self, code: str) -> Dict:
         r = requests.post(url, data=code)
         return {'response': r.text}
 
-    def get_file(self, filename: str, directory: str = 'gcodes') -> str:
+    def get_file(self, filename: str, directory: str = 'gcodes', binary: bool = False) -> str:
         """
         filename: name of the file you want to download including extension
         directory: the folder that the file is in, options are ['gcodes', 'macros', 'sys']
+        binary: return binary data instead of a string
 
-        returns the file as a string
+        returns the file as a string or binary data
         """
         url = f'{self.base_url}/machine/file/{directory}/{filename}'
         r = requests.get(url)
         if not r.ok:
             raise ValueError
-        return r.text
+        if binary:
+            return r.content
+        else:
+            return r.text
 
-    def upload_file(self, file: Union[StringIO, TextIOWrapper], filename: str, directory: str = 'gcodes') -> Dict:
+    def upload_file(self, file: Union[str, bytes, StringIO, TextIOWrapper, BytesIO], filename: str, directory: str = 'gcodes') -> Dict:
         """
         file: the path to the file you want to upload from your PC
         directory: the folder that the file is in, options are ['gcodes', 'macros', 'sys']
-
-        returns the file as a string
         """
         url = f'{self.base_url}/machine/file/{directory}/{filename}'
         r = requests.put(url, data=file, headers={'Content-Type': 'application/octet-stream'})

duetwebapi/api/dwc_api.py

@@ -56,20 +56,24 @@ def send_code(self, code: str) -> Dict:
         reply = self._get_reply()
         return {'response': reply}
 
-    def get_file(self, filename: str, directory: str = 'gcodes') -> str:
+    def get_file(self, filename: str, directory: str = 'gcodes', binary: bool = False) -> str:
         """
         filename: name of the file you want to download including extension
         directory: the folder that the file is in, options are ['gcodes', 'macros', 'sys']
+        binary: return binary data instead of a string
 
-        returns the file as a string
+        returns the file as a string or binary data
         """
         url = f'{self.base_url}/rr_download'
         r = requests.get(url, {'name': f'/{directory}/{filename}'})
         if not r.ok:
             raise ValueError
-        return r.text
+        if binary:
+            return r.content
+        else:
+            return r.text
 
-    def upload_file(self, file: Union[StringIO, TextIOWrapper], filename: str, directory: str = 'gcodes') -> Dict:
+    def upload_file(self, file: Union[str, bytes, StringIO, TextIOWrapper, BytesIO], filename: str, directory: str = 'gcodes') -> Dict:
         url = f'{self.base_url}/rr_upload?name=/{directory}/{filename}'
         r = requests.post(url, data=file)
         if not r.ok:

requirements_dev.txt

@@ -1,5 +1,5 @@
 autopep8==1.5.4
-bleach==3.2.1
+bleach==3.3.0
 bumpversion
 certifi==2020.6.20
 chardet==3.0.4