Wiopy

Clean up code quality, docs, and stability.

"Breaking" Changes

A few names of classes and functions were changed. However, you should not have been using them in the first place. If you were ... sorry.

* `WalmartResponse` -> `_WalmartResponse`
* `get_items_ids` -> `_get_items_ids`
* `ttl_cache` -> `_ttl_cache`

Bug Fixes

* `WalmartReviewResponse.reviews` now returns the proper object type
* `WalmartProduct.customerRatingImage` showed up twice in API docs; therefor showing up twice in the class. Duplicate has been removed.
* `taxonomy` now explicitly constructs response object

Stricter Linting

Switched to using Ruff for linting and applying more rules. See `pyproject.toml` for the exact list. When possible, these rules are followed. If a rule is not possible to follow, a `noqa` is added to that line. Or, in the case of static checking, a `type: ignore` is added.

Better Docstrings

The docstrings are now following the Numpy doc standards. Before, they were a strange hybrid of numpy and google.

Better Stability

A few areas of code were wrong. And some had room for raising an error, if the Walmart servers returned garbage data.

Response items that construct objects from lists, now include a `dict.get(...) or []` to prevent a `NoneType object is not iterable`.
Other small, miscellaneous code quality and readability changes were made.

Notes

4 / 3 was caused by an annotation issue. Originally, I solved this by using `List` over `list`. However, I have returned to using the newer annotations. That means that the code is now using `from __future__ import annotations`

This package should no longer have any development needed on it, unless a change to the Walmart I/O system occurs. If you have any issues or find any bugs, please open an issue and I will get to it (you are welcome to try to fix it yourself, PRs are welcome.)
If no issues are found, do not expect any more development on this package. If Walmart I/O makes any breaking changes, you are welcome to notify me. However, depending on those changes, I might not maintain this package.

Major Release

Better Performance
* Request headers implement TTL Cache
* WalmartIO and AsyncWalmartIO now use `__slots__`

Breaking Changes
* `ResponseHandler` -> `_ResponseHandler` (you should not be using this class to being with)
* WalmartIO and AsyncWalmartIO now use `__slots__`; You can no longer create dynamic attributes inside these classes
* Internal utils are no longer exposed
* `import WIOpy` -> `import wiopy`

Other changes
* No longer using `setuptools`. Now using hatching and `pyproject.toml`
* Fix 4 (a re-explanation of 3)
* Changed warning level of large `product_lookup` to be debug
* Added explicit docstrings to `AsyncWAlmartIO`
* Cleaned up some incorrect docstring info
* Removed redundant custom error types

v_011
Added retries to the bulk look-up. In prolonged testing, no issues have arisen, so the wrapper is ready for a non-pre-release.

v_009_alpha
Fix __init__

Fix errors in async with error handling and added extra error catch to bulk lookup

Update logging

v_007_alpha
Asynchronous calls were added.

WIOpy now supports awaiting with the AsyncWalmartIO class


v_006_alpha
Changes:

bulk_product_lookup became a generator

v_005_alpha
Added logging module and bulk lookups.

The bulk lookup allows you to lookup a large number of ids without worrying that an error will break everything.

Giving the class your publisherId during init, means you do not have to provide it as a kwarg for any call.


Removed mystery import that should never have been there.

v_003_alpha
Update to documentation critical info

v_002-alpha
Setup code and testing. The wrapper is ready to use just not fully tested for all cases yet.

What is new:
- Everything lol
- Affiliate API calls