feat: add PaginationList to improve how we deal with pagination

[browniebroke]

Inspired by pagination from PyGithub and I liked how they do it

• Add new PaginationList class with basic features: iterable + total count
• Update existing code to use it
• Update existing tests
• Add new tests to cover edge cases
• Update documentation
• Make sure that the change is flagged as breaking

Fix #137

[codecov]

Codecov Report

Merging #425 (56e9a2a) into main (96df7b8) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #425   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            5         6    +1     
  Lines          476       500   +24     
  Branches        35        40    +5     
=========================================
+ Hits           476       500   +24     

Impacted Files	Coverage Δ
deezer/__init__.py	100.00% <100.00%> (ø)
deezer/client.py	100.00% <100.00%> (ø)
deezer/pagination.py	100.00% <100.00%> (ø)
deezer/resources.py	100.00% <100.00%> (ø)

---

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 96df7b8...56e9a2a. Read the comment docs.

[sourcery-ai]

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 1.83%.

Quality metrics	Before	After	Change
Complexity	1.02 ⭐	1.00 ⭐	-0.02 👍
Method Length	28.71 ⭐	26.13 ⭐	-2.58 👍
Working memory	4.34 ⭐	4.12 ⭐	-0.22 👍
Quality	89.87% ⭐	91.70% ⭐	1.83% 👍

Other metrics	Before	After	Change
Lines	1675	1343	-332

Changed files	Quality Before	Quality After	Quality Change
conftest.py	90.62% ⭐	90.62% ⭐	0.00%
deezer/init.py	83.52% ⭐	83.03% ⭐	-0.49% 👎
deezer/client.py	81.51% ⭐	81.89% ⭐	0.38% 👍
deezer/resources.py	93.26% ⭐	91.78% ⭐	-1.48% 👎
tests/test_client.py	94.48% ⭐	94.61% ⭐	0.13% 👍
tests/test_resources.py	88.70% ⭐	95.00% ⭐	6.30% 👍

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
deezer/client.py	Client._process_json	15 🙂	127 😞	10 😞	51.46% 🙂	Try splitting into smaller methods. Extract out complex expressions
deezer/client.py	Client.request	4 ⭐	90 🙂	10 😞	66.42% 🙂	Extract out complex expressions
deezer/client.py	Client.search	0 ⭐	54 ⭐	14 😞	69.24% 🙂	Extract out complex expressions
tests/test_client.py	TestClient.test_process_json_types	0 ⭐	130 😞	7 🙂	71.78% 🙂	Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!