unblob icon indicating copy to clipboard operation
unblob copied to clipboard

Define public API surface

Open vlaci opened this issue 3 years ago • 1 comments

Unblob is converted to a py.typed library in #352. After that change we are also able to define library-private and public modules and types. We should expose the functionality needed for external handlers and for running unblob as library and make the related code public.

https://github.com/microsoft/pyright/blob/main/docs/typed-libraries.md#library-interface

vlaci avatar Apr 21 '22 09:04 vlaci

It is better and easier to start with the absolute minimal public surface and open up later, because once we make something public, we essentially can't "take it back", because people can start relying on those. Also it's easier to refactor internal implementation when we don't expose too much.

Therefore I suggest to expose only the main entry point process_files and the related objects (ExtractionConfig and Report), and later we can open other functions as necessary.

kissgyorgy avatar Apr 22 '22 09:04 kissgyorgy