SCROLL: Can we make a tool that automatically generates documentation and unit-tests for procedural processing programs?
The purpose of this tool is to reduce the hustle / tediousness of documenting and writing unit tests for real-time data processing programs.
An ideal use would be a tool which listens to your program running,
- registers the input and output of the functions, once for each function to save memory
- records the functions order of running
- generates documentation and tests in this running order using the (recorded input/output as examples in docs, recorded input/output to generate unit tests, automatically adds type hints to docs by checking type(input))
This tool should generate all this by monitoring you running a functional test.
The final goal is to enable a developer/user browser through documentation that flows in the order in which functions in the program run, hence the name SCROLL.
- I think this will make a developer break down their code a more to ducument as many steps (details) of the process as possible
- What happens to methods that dont explicitly take in input and out but rather just modify class variables when called?
- Can this be adpted for pandas based projects if successful?
- I know that no such tool exists to automatically generate unit tests and docs in the running order of your code.
- (pythoscope)[https://github.com/mkwiatkowski/pythoscope] for Auto unit-test generation
- (auger)[https://github.com/laffra/auger] for Auto Unit-test generation
- (MonkeyType)[https://github.com/Instagram/MonkeyType] for auto Auto Type hinting / Annotation
- (hypothesis)[https://hypothesis.readthedocs.io/en/latest/index.html] for Auto test-case generation