Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define public API surface #353

Open
vlaci opened this issue Apr 21, 2022 · 1 comment
Open

Define public API surface #353

vlaci opened this issue Apr 21, 2022 · 1 comment
Milestone

Comments

@vlaci
Copy link
Contributor

vlaci commented Apr 21, 2022

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

@kissgyorgy
Copy link
Contributor

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.

@martonilles martonilles added this to the Public Launch milestone Apr 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants