[WIP] convert and optimize image in a single pass

[cking100]

Fixes #284

Changes:

• Enhanced optimize_xxx functions to accept a convert parameter
• Modified optimize_image and optimize_gif to accept io.BytesIO as input
• Added support for bytes in src
• optimize_xxx now works on single pass

TODO

• Write test cases

[benoit74]

I've converted PR to draft since it is not ready, please mark it as ready once ... ready 🤣

[codecov]

Codecov Report

❌ Patch coverage is 58.99281% with 57 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.32%. Comparing base (8c16fa6) to head (5e59e5c).

Files with missing lines	Patch %	Lines
src/zimscraperlib/image/optimization.py	58.99%	43 Missing and 14 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #289      +/-   ##
==========================================
- Coverage   99.52%   97.32%   -2.20%     
==========================================
  Files          41       41              
  Lines        2516     2584      +68     
  Branches      354      383      +29     
==========================================
+ Hits         2504     2515      +11     
- Misses          8       51      +43     
- Partials        4       18      +14     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[cking100]

@benoit74 I will add the test cases soon. But, before that, can I please get a review on the changes?

[benoit74]

Few remarks. You are on the right path, thank you

[benoit74]

Docstring is not accurate anymore

[benoit74]

I agree it is convenient to have the option to pass this when we already know the format to save the addition format_for, but I don't get why it would be mandatory for io.BytesIO, can you explain? format_for accepts io.BytesIO AFAIK.

I would recommend to rename this to src_format for clarity.

[cking100]

You're right. format_for does detect io.BytesIO and thus, fmt is not mandatory. This is a mistake, I will fix it and also rename it since we would need dst_format to accept io.BytesIO as dst.

[benoit74]

I would like (if reasonably feasible) that we accept at least io.BytesIO as dst, bytes as well if feasible. This mandates to add dst_format as argument, but I'm fine with this.

We also need to add all meaningful signatures with @overloads so that it is clearer when a given argument is optional or mandatory at type checking time (in addition to the live checks the function performs afterwards).

[cking100]

I agree we should accept io.BytesIO as dst, but I am not sure how we would be able to work with dst as bytes, as they are immutable. If you have any ideas lmk.

I will push a patch for dst to accept io.BytesIO soon.

[benoit74]

Indeed, dst as bytes makes no sense, too early comment on my side 🤣