tm1py icon indicating copy to clipboard operation
tm1py copied to clipboard

Clean up write back method names

Open rclapp opened this issue 1 year ago • 3 comments

TM1py methods like write_dataframe_async and write_async names are confusing and misleading. These methods parallelize write back operations, and don't expose async write operations.

https://github.com/cubewise-code/tm1py/blob/master/TM1py/Services/CellService.py#L758 https://github.com/cubewise-code/tm1py/blob/master/TM1py/Services/CellService.py#L690

Instead, they should be named something like write_dataframe_chunked or write_dataframe_parallel.

rclapp avatar Sep 12 '23 18:09 rclapp

Agree. I like write_dataframe_parallel.

MariusWirtz avatar Sep 12 '23 19:09 MariusWirtz

An alternative solution here would be to expose the optional parallelization to the normal functions through additional arguments like max_workers as was done in #1030 on execute_mdx, execute_view.

This approach has proven beneficial in the implementation as it allows for efficient recycling of the existing test cases without code duplication.

MariusWirtz avatar Jan 23 '24 20:01 MariusWirtz

I agree I think the more we standardize the better. I like that option

rclapp avatar Jan 23 '24 20:01 rclapp