update file upload & base_url property

Author: AndyEveritt

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.1.2-b1
+current_version = 1.1.2-b3
 commit = False
 tag = False
 allow_dirty = False

Makefile

@@ -8,7 +8,7 @@ verbosity=1
 # `bumpversion --tag release
 
 update_dist:
-	rm dist/*
+	rm dist/* -f
 	python setup.py sdist bdist_wheel
 
 check_dist:

README.md

@@ -35,7 +35,7 @@ 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: str, directory: str = 'gcodes') -> Dict` | Upload file to Duet
+`upload_file(file: StringIO | TextIOWrapper, 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/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "1.1.2-b1"
+__version__ = "1.1.2-b3"
 
 from .dwa_factory import DuetWebAPI

duetwebapi/api/base.py

@@ -1,4 +1,5 @@
-from typing import Dict, List
+from typing import Dict, List, Union
+from io import StringIO, TextIOWrapper
 import requests
 import os
 import logging
@@ -8,13 +9,18 @@ class DuetAPI:
     api_name = ''
 
     def __init__(self, base_url: str) -> None:
-        if not base_url.startswith('http://'):
-            base_url = f'http://{base_url}'
-        self._base_url = base_url
+        self.base_url = base_url
 
+    @property
     def base_url(self):
         return self._base_url
 
+    @base_url.setter
+    def base_url(self, value: str):
+        if not value.startswith('http://'):
+            value = f'http://{value}'
+        self._base_url = base_url
+
     def get_model(self, key: str = None) -> Dict:
         """ Get Duet object model. RRF3 only """
         raise NotImplementedError
@@ -27,7 +33,7 @@ def get_file(self, filename: str, directory: str = 'gcodes') -> str:
         """ Get file from Duet """
         raise NotImplementedError
 
-    def upload_file(self, file: str, directory: str = 'gcodes') -> Dict:
+    def upload_file(self, file: Union[StringIO, TextIOWrapper], filename: str, directory: str = 'gcodes') -> Dict:
         """ Upload file to Duet """
         raise NotImplementedError
 
@@ -50,5 +56,3 @@ def get_directory(self, directory: str) -> List[Dict]:
     def create_directory(self, directory: str) -> Dict:
         """ Create a new directory """
         raise NotImplementedError
-
-pass

duetwebapi/api/dsf_api.py

@@ -1,6 +1,7 @@
 import logging
 import os
-from typing import Dict, List
+from typing import Dict, List, Union
+from io import StringIO, TextIOWrapper
 
 import requests
 
@@ -17,16 +18,13 @@ class DSFAPI(DuetAPI):
     api_name = 'DSF_REST'
 
     def get_model(self, **_ignored) -> Dict:
-        url = f'{self._base_url}/machine/status'
+        url = f'{self.base_url}/machine/status'
         r = requests.get(url)
-        if not r.ok:
-            raise ValueError
-        j: Dict = r.json()
-        result = j['result'] if j.get('result') else j
-        return result
+        j = r.json()
+        return j
 
     def send_code(self, code: str) -> Dict:
-        url = f'{self._base_url}/machine/code'
+        url = f'{self.base_url}/machine/code'
         r = requests.post(url, data=code)
         return {'response': r.text}
 
@@ -37,58 +35,55 @@ def get_file(self, filename: str, directory: str = 'gcodes') -> str:
 
         returns the file as a string
         """
-        url = f'{self._base_url}/machine/file/{directory}/{filename}'
+        url = f'{self.base_url}/machine/file/{directory}/{filename}'
         r = requests.get(url)
         if not r.ok:
             raise ValueError
         return r.text
 
-    def upload_file(self, file: str, directory: str = 'gcodes') -> Dict:
+    def upload_file(self, file: Union[StringIO, TextIOWrapper], 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
         """
-        file = os.path.abspath(file).replace('\\', '/')
-        filename = file.split('/')[-1]
-        url = f'{self._base_url}/machine/file/{directory}/{filename}'
-        with open(file, 'rb') as f:
-            r = requests.put(url, data=f, headers={'Content-Type': 'application/octet-stream'})
+        url = f'{self.base_url}/machine/file/{directory}/{filename}'
+        r = requests.put(url, data=file, headers={'Content-Type': 'application/octet-stream'})
         if not r.ok:
             raise ValueError
         return {'err': 0}
 
     def get_fileinfo(self, filename: str = None, directory: str = 'gcodes') -> Dict:
-        url = f'{self._base_url}/machine/fileinfo/{directory}/{filename}'
+        url = f'{self.base_url}/machine/fileinfo/{directory}/{filename}'
         r = requests.get(url)
         if not r.ok:
             raise ValueError
         return r.json()
 
     def delete_file(self, filename: str, directory: str = 'gcodes') -> Dict:
-        url = f'{self._base_url}/machine/file/{directory}/{filename}'
+        url = f'{self.base_url}/machine/file/{directory}/{filename}'
         r = requests.delete(url)
         if not r.ok:
             raise ValueError
         return {'err': 0}
 
     def move_file(self, from_path: str, to_path: str, force: bool = False) -> Dict:
-        url = f'{self._base_url}/machine/file/move'
+        url = f'{self.base_url}/machine/file/move'
         r = requests.post(url, {'from': f'{from_path}', 'to': f'{to_path}', 'force': force})
         if not r.ok:
             raise ValueError
         return {'err': 0}
 
     def get_directory(self, directory: str) -> List[Dict]:
-        url = f'{self._base_url}/machine/directory/{directory}'
+        url = f'{self.base_url}/machine/directory/{directory}'
         r = requests.get(url)
         if not r.ok:
             raise ValueError
         return r.json()
 
     def create_directory(self, directory: str) -> Dict:
-        url = f'{self._base_url}/machine/directory/{directory}'
+        url = f'{self.base_url}/machine/directory/{directory}'
         r = requests.put(url)
         if not r.ok:
             raise ValueError

duetwebapi/api/dwc_api.py

@@ -1,6 +1,7 @@
 import logging
 import os
-from typing import Dict, List
+from typing import Dict, List, Union
+from io import StringIO, TextIOWrapper
 
 import requests
 
@@ -17,15 +18,15 @@ class DWCAPI(DuetAPI):
     api_name = 'DWC_REST'
 
     def get_model(self, key: str = None) -> Dict:
-        url = f'{self._base_url}/rr_model'
+        url = f'{self.base_url}/rr_model'
         r = requests.get(url, {'flags': 'd99vn', 'key': key})
         if not r.ok:
             raise ValueError
         j = r.json()
         return j['result']
 
     def send_code(self, code: str) -> Dict:
-        url = f'{self._base_url}/rr_gcode'
+        url = f'{self.base_url}/rr_gcode'
         r = requests.get(url, {'gcode': code})
         if not r.ok:
             raise ValueError
@@ -38,24 +39,21 @@ def get_file(self, filename: str, directory: str = 'gcodes') -> str:
 
         returns the file as a string
         """
-        url = f'{self._base_url}/rr_download'
+        url = f'{self.base_url}/rr_download'
         r = requests.get(url, {'name': f'/{directory}/{filename}'})
         if not r.ok:
             raise ValueError
         return r.text
 
-    def upload_file(self, file: str, directory: str = 'gcodes') -> Dict:
-        file = os.path.abspath(file).replace('\\', '/')
-        filename = file.split('/')[-1]
-        url = f'{self._base_url}/rr_upload?name=/{directory}/{filename}'
-        with open(file, 'rb') as f:
-            r = requests.post(url, data=f)
+    def upload_file(self, file: Union[StringIO, TextIOWrapper], 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:
             raise ValueError
         return r.json()
 
     def get_fileinfo(self, filename: str = None, directory: str = 'gcodes') -> Dict:
-        url = f'{self._base_url}/rr_fileinfo'
+        url = f'{self.base_url}/rr_fileinfo'
         if filename:
             r = requests.get(url, {'name': f'/{directory}/{filename}'})
         else:
@@ -65,7 +63,7 @@ def get_fileinfo(self, filename: str = None, directory: str = 'gcodes') -> Dict:
         return r.json()
 
     def delete_file(self, filename: str, directory: str = 'gcodes') -> Dict:
-        url = f'{self._base_url}/rr_delete'
+        url = f'{self.base_url}/rr_delete'
         r = requests.get(url, {'name': f'/{directory}/{filename}'})
         if not r.ok:
             raise ValueError
@@ -74,21 +72,21 @@ def delete_file(self, filename: str, directory: str = 'gcodes') -> Dict:
     def move_file(self, from_path, to_path, **_ignored):
         # BUG this doesn't work currently
         raise NotImplementedError
-        url = f'{self._base_url}/rr_move'
+        url = f'{self.base_url}/rr_move'
         r = requests.get(url, {'old': f'{from_path}', 'new': f'{to_path}'})
         if not r.ok:
             raise ValueError
         return r.json()
 
     def get_directory(self, directory: str) -> List[Dict]:
-        url = f'{self._base_url}/rr_filelist'
+        url = f'{self.base_url}/rr_filelist'
         r = requests.get(url, {'dir': f'/{directory}'})
         if not r.ok:
             raise ValueError
         return r.json()['files']
 
     def create_directory(self, directory: str) -> Dict:
-        url = f'{self._base_url}/rr_mkdir'
+        url = f'{self.base_url}/rr_mkdir'
         r = requests.get(url, {'dir': f'/{directory}'})
         if not r.ok:
             raise ValueError

examples.py

@@ -17,8 +17,9 @@
 riley.send_code('M115')
 bruce.send_code('M115')
 
-riley.upload_file('test.gcode')
-bruce.upload_file('test.gcode')
+with open('test.gcode', 'r') as f:
+    riley.upload_file(f, 'test.gcode')
+    bruce.upload_file(f, 'test.gcode')
 
 riley.get_file('test.gcode')
 bruce.get_file('test.gcode')

requirements_dev.txt

@@ -1,5 +1,6 @@
 autopep8==1.5.4
 bleach==3.2.1
+bumpversion
 certifi==2020.6.20
 chardet==3.0.4
 colorama==0.4.4
@@ -22,3 +23,4 @@ tqdm==4.51.0
 twine==3.2.0
 urllib3==1.25.11
 webencodings==0.5.1
+wheel

setup.py

@@ -9,7 +9,7 @@
 
 setup(
     name="duetwebapi",
-    version="1.1.2-b1",
+    version="1.1.2-b3",
     include_package_data=True,
     packages=find_packages(),