Return list[str] when passed multiple values from python

[MusicalNinjaDad]

Summary by Sourcery

This pull request introduces a new return type for the fizzbuzz function, allowing it to return either a single string or a list of strings based on the input. The documentation and tests have been updated accordingly to reflect these changes.

• Enhancements:
  • Updated the fizzbuzzo3.fizzbuzz function to return a list of strings when passed a list or range of numbers, instead of a single concatenated string.
  • Enhanced the documentation to reflect the new return types for the fizzbuzz function, providing clearer examples and explanations.
  • fizzbuzzo3: Introduced a new return type FizzBuzzReturn to handle different return types for the fizzbuzz function, allowing it to return either a single string or a list of strings based on the input.
• Documentation:
  • Added detailed documentation on how to implement and use the new FizzBuzzReturn type in docs/dev-build.md.
  • Updated the type hints and docstrings in python/fizzbuzz/fizzbuzzo3.pyi to reflect the new return types for the fizzbuzz function.
• Tests:
  • Modified existing tests to check for the new return type (list of strings) when passing a list or range of numbers to the fizzbuzz function.
  • Added new test cases to ensure the fizzbuzz function returns an empty list for invalid slice ranges.
• Chores:
  • Commented out the Python performance tests in tests/perftest.py to focus on Rust performance comparisons.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request modifies the fizzbuzz function to return a list of strings when passed multiple values, instead of a single concatenated string. The changes involve updating the Rust implementation, Python interface, and associated documentation and tests.

File-Level Changes

Files	Changes
rust/fizzbuzzo3/src/lib.rs python/fizzbuzz/fizzbuzzo3.pyi	Updated the implementation and interface of the fizzbuzz function to return a list of strings when passed multiple values.
tests/test_fizzbuzzo3.py tests/perftest.py	Updated tests to reflect the new return type and added performance tests for different return types.
docs/dev-build.md tests/perf_results.md	Updated documentation to explain the new return type and added performance comparison results.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[MusicalNinjaDad]

Fixes: #51

[sourcery-ai]

Hey @MusicalNinjaDad - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 7 issues found
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟢 Complexity: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Additional details and impacted files

Flag	Coverage Δ
fizzbuzz	93.84% <ø> (ø)
fizzbuzzo3	87.50% <100.00%> (ø)
python	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📢 Thoughts on this report? Let us know!

[MusicalNinjaDad]

@sourcery-ai review

[sourcery-ai]

We have skipped reviewing this pull request. It looks like we've already reviewed this pull request.