Major rework: more pythonic API, code rework

[Mattwmaster58]

Here's the things I did (which fixes #37 ):

• refactored code to
• ran black
• made function docstring
• added type hints here and there
• refactored to allow things like a contrib module

What I didn't do (possibly yet):

• optimize for performance
  • if doing so, I'd like to use numpy (if it exists) to optimize stuff
    • if that's not possible or/and I dont't feel like that, I guess I could perform micro-optimizations I used to make the code more readable if necessary
• test deliberate failures (reason for decreased coverage)

What I need to do:

• update docs

[codecov]

Codecov Report

Merging #38 into master will decrease coverage by 0.19%.
The diff coverage is 94.44%.

@@            Coverage Diff             @@
##           master      #38      +/-   ##
==========================================
- Coverage   97.67%   97.47%   -0.20%     
==========================================
  Files           1        1              
  Lines         129      119      -10     
==========================================
- Hits          126      116      -10     
  Misses          3        3              

Impacted Files	Coverage Δ
pixelmatch/__init__.py	97.47% <94.44%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ed84e4...cf3f10d. Read the comment docs.

[Mattwmaster58]

After thinking about this some more, it probably would make more sense to import PIL.Image gracefully and then check with isinstance/subclass. Otherwise, how would the user load the image in the first place?

[whtsky]

Thanks for your contribution!

It would be nice if you can split the PIL support, general code cleanup and type hints into different PRs -- this can make code review a lot easier for me :)

I just found that there's no type checking in CI right now, I'll add them tonight.

[Mattwmaster58]

Totally get WRT splitting up PRs. I'll try to get a different one out for PIL support

[Mattwmaster58]

Alright. I removed all the PIL specific code and moved pixelmatch to __init__ to lay the groundwork for a contrib module. And type hinted the rest of the code.

[whtsky]

Also please don't checkin pixelmatch/contrib as they are empty right now.

[Mattwmaster58]

I had a vague idea that git didn't track empty files/folders, turns out it's only empty folders 😄

[whtsky]

Looks nice. Can you rebase or merge master and solves the conflict? Thanks

[Mattwmaster58]

Done

[whtsky]

https://github.com/Mattwmaster58/pixelmatch-py/runs/657071069?check_suite_focus=true

There are some type errors :(

[Mattwmaster58]

Fixed Fixed. Wow, black got me multiple times there. Maybe some pre-commit hooks to run black would be in order 😉

[whtsky]

Maybe some pre-commit hooks to run black would be in order 😉

Personally I use editor's auto format: https://github.com/psf/black#editor-integration

Python's pre-commit requires manual install, and I have some unpleasant experience with it due to Python venv switching.

[whtsky]

Merged, thanks!

[whtsky]

https://pypi.org/project/pixelmatch/0.2.0/

[Mattwmaster58]

Thanks for the quick release!

…

On Fri, May 8, 2020 at 12:33 PM Wu Haotian ***@***.***> wrote: https://pypi.org/project/pixelmatch/0.2.0/ — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#38 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGI56LPJFOMCTBXGB6446HTRQRF7PANCNFSM4M3RAQCA> .

-- *Either I will find a way, or I will make one.** - Phillip Sydney*