Async feature implementation using threading library

[NimaSamadi007]

Due to the previous inconsistencies of async feature implementation, the threading library is used to implement the async-like sound-playing feature. Tests are provided in the test directory. Github build fails due to some issues with the function_test.py script which I'm not sure why.
It seems that when the parent thread of the subprocess is dead, its child process doesn't die automatically. In other words, in async mode, if the user program ends before the sound playing is finished, the user can hear the voice although the program is terminated. Therefore, it seems that we need some sort of cleanup procedure to kill/terminate these child threads so they don't end up being zombie processes. The best way to do this is to use class destructors but as of now, the code is more function-oriented rather than object-oriented. For now, I used Python's atexit library to run the cleanup procedure. Any other comments are welcome!

[codecov]

Codecov Report

Patch coverage: 42.42% and project coverage change: -30.87% ⚠️

Comparison is base (3d3ec51) 100.00% compared to head (fb5b259) 69.13%.

Additional details and impacted files

@@             Coverage Diff              @@
##               dev      #28       +/-   ##
============================================
- Coverage   100.00%   69.13%   -30.87%     
============================================
  Files            3        3               
  Lines           56       81       +25     
  Branches         4        7        +3     
============================================
  Hits            56       56               
- Misses           0       24       +24     
- Partials         0        1        +1     

Files Changed	Coverage Δ
nava/functions.py	65.27% <42.42%> (-34.73%)	⬇️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sepandhaghighi]

@NimaSamadi007 Well done 💯
This approach looks good to me!

1. I think it would be better to return proc in the __play_sync_linux function instead of declaring a new function like __play_non_blocking_linux. This work will prevent future duplications.

2. It seems there is a minor issue in import/call of the __cleanup_processes function in __init__.py

3. Continue your work for other platforms

Good luck 🔥

[NimaSamadi007]

Thanks 🙏, that's great.

• Yeah sure. I will call __play_sync_linux in the thread target function. However, it seems that there's no straightforward way to access the return value of the thread. There are two approaches:
  1. Use a global variable or an input variable that acts like the return value (similar to what's done in C)
  2. Modify run() method in class definition
     I will use the first approach and always save the process handler in a list.
• I will test it again. Thanks for mentioning.
• Yeah sure. I will also develop the code for Windows, but I'm not sure how I'm supposed to test the code for MacOS.

[NimaSamadi007]

Hello all. I implemented the Windows async feature and applied the requested codebase changes. Please help to check it. I don't have access to a MacOS-based device. So, I couldn't implement the async feature for MacOS. Should I install it in a virtualized environment and work on it or do you have any other suggestions? I haven't worked with MacOS before so I don't know if it's even possible to do this.

[sadrasabouri]

Hello all. I implemented the Windows async feature and applied the requested codebase changes. Please help to check it. I don't have access to a MacOS-based device. So, I couldn't implement the async feature for MacOS. Should I install it in a virtualized environment and work on it or do you have any other suggestions? I haven't worked with MacOS before so I don't know if it's even possible to do this.

Thanks Nima. You just needed to implement macOS by replacing aplay by afplay. I will test it in my friend's laptop.

[NimaSamadi007]

I implemented the macOS async feature similar to Linux implementation. By the way, in Windows, you can specify a flag to play the sound in async mode and you don't need to worry about the underlying process getting killed or not and everything is handled in winsound. However, this causes some sort of inconsistent API across different operating systems. In other words, in Windows, high-level users won't get any thread handler while that's not the case in Linux and macOS. I'm not sure if it's okay or not.

[sadrasabouri]

Thanks Nima. It looks good to me.
Just remove test/__init__.py and test/main.py. We will add tests for it after this PR.

[sepandhaghighi]

🚀