Skip to content

Commit fb24c1b

Browse files
author
AndyEveritt
committed
update type hinting
1 parent 6bcc26a commit fb24c1b

4 files changed

Lines changed: 6 additions & 8 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ Method | Description
3434
------ | -----------
3535
`get_model(key: str = None) -> Dict` | Get Duet object model. RRF3 only
3636
`send_code(code: str) -> Dict` | Send G/M/T-code to Duet
37-
`get_file(filename: str, directory: str = 'gcodes') -> str` | Download file from Duet
38-
`upload_file(file: StringIO \| TextIOWrapper, filename: str, directory: str = 'gcodes') -> Dict` | Upload file to Duet
37+
`get_file(filename: str, directory: str = 'gcodes', binary: bool = False) -> str` | Download file from Duet
38+
`upload_file(file: str \| bytes \| StringIO \| TextIOWrapper \| BytesIO, filename: str, directory: str = 'gcodes') -> Dict` | Upload file to Duet
3939
`get_fileinfo(filename: str = None, directory: str = 'gcodes') -> Dict` | Get file info
4040
`delete_file(filename: str, directory: str = 'gcodes') -> Dict` | Delete file on Duet
4141
`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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ def send_code(self, code: str) -> Dict:
3737
""" Send G/M/T-code to Duet """
3838
raise NotImplementedError
3939

40-
def get_file(self, filename: str, directory: str = 'gcodes') -> str:
40+
def get_file(self, filename: str, directory: str = 'gcodes', binary: bool = False) -> str:
4141
""" Get file from Duet """
4242
raise NotImplementedError
4343

44-
def upload_file(self, file: Union[StringIO, TextIOWrapper], filename: str, directory: str = 'gcodes') -> Dict:
44+
def upload_file(self, file: Union[str, bytes, StringIO, TextIOWrapper, BytesIO], filename: str, directory: str = 'gcodes') -> Dict:
4545
""" Upload file to Duet """
4646
raise NotImplementedError
4747

duetwebapi/api/dsf_api.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,10 @@ def get_file(self, filename: str, directory: str = 'gcodes', binary: bool = Fals
4545
else:
4646
return r.text
4747

48-
def upload_file(self, file: Union[StringIO, TextIOWrapper, bytes], filename: str, directory: str = 'gcodes') -> Dict:
48+
def upload_file(self, file: Union[str, bytes, StringIO, TextIOWrapper, BytesIO], filename: str, directory: str = 'gcodes') -> Dict:
4949
"""
5050
file: the path to the file you want to upload from your PC
5151
directory: the folder that the file is in, options are ['gcodes', 'macros', 'sys']
52-
53-
returns the file as a string
5452
"""
5553
url = f'{self.base_url}/machine/file/{directory}/{filename}'
5654
r = requests.put(url, data=file, headers={'Content-Type': 'application/octet-stream'})

duetwebapi/api/dwc_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def get_file(self, filename: str, directory: str = 'gcodes', binary: bool = Fals
7373
else:
7474
return r.text
7575

76-
def upload_file(self, file: Union[StringIO, TextIOWrapper, bytes], filename: str, directory: str = 'gcodes') -> Dict:
76+
def upload_file(self, file: Union[str, bytes, StringIO, TextIOWrapper, BytesIO], filename: str, directory: str = 'gcodes') -> Dict:
7777
url = f'{self.base_url}/rr_upload?name=/{directory}/{filename}'
7878
r = requests.post(url, data=file)
7979
if not r.ok:

0 commit comments

Comments
 (0)