OmniClientWrapper
- class omni.kit.converter.common.OmniClientWrapper
Bases:
objectHelper class based on omni.client library
Methods
copy(src_path, dest_path)Asynchronously copy an item from src_url to dst_url and wait for the result
copy_sync(src_path, dest_path)Copy an item from src_url to dst_url and wait for the result
create_folder(path)Asynchronously create a folder
create_folder_sync(path)Create a folder
exists(path)Asynchronously Retrieve information about a single item
exists_sync(path)Retrieve information about a single item and wait for the result
read(src_path)Asynchronously read a file
write(path, content)Asynchronously write a file
- __init__()
- async static copy(src_path: str, dest_path: str)
Asynchronously copy an item from src_url to dst_url and wait for the result
- Parameters
src_path – input file to copy
dest_path – destination path to copy to
- Returns
true if successfully copied to destination
- Return type
boolean
- static copy_sync(src_path: str, dest_path: str)
Copy an item from src_url to dst_url and wait for the result
- Parameters
src_path – input file to copy
dest_path – destination path to copy to
- Returns
true if successfully copied to destination
- Return type
boolean
- async static create_folder(path)
Asynchronously create a folder
- static create_folder_sync(path)
Create a folder
- async static exists(path)
Asynchronously Retrieve information about a single item
- Parameters
path – file path
- Returns
true if the result is OK
- Return type
boolean
- static exists_sync(path)
Retrieve information about a single item and wait for the result
- Parameters
path – file path
- Returns
true if the result is OK
- Return type
boolean
- async static read(src_path: str)
Asynchronously read a file
- async static write(path: str, content)
Asynchronously write a file
- Parameters
path – output file path
- Returns
true if file was written successfully
- Return type
boolean