Client Cache Controller

[dgunning]

@paultiq What is the rollout plan for the request caching? Are we ready to explicitly add the dependencies to the library? Turn the feature on?

[paultiq]

The code was implemented in two passes:

First to swap in HTTPX instead of requests. This was more "invasive", because it touched a lot of code. My thinking was: let's make sure this is stable before taking the next step.

Second step was to implement an optional caching layer, with caching rules. I'd like to clean this code up a bit and do a little more testing... the httpclient and httpclient_cache is a bit too convoluted right now.

My next steps/plan was:

• Write up a markdown summary of the feature and configuration options
• Clean up the code: it's a little more convoluted than it needs to be. It'd be much simpler if/when I merge httpclient and httpclient_cache.

Two questions about caching are:

1. How should it be enabled/disabled?
2. What should edgartools use as a default directory to store the cache?

I should be able to finish the cleanup shortly, I already started it locally.

[dgunning]

What about explicitly adding the libraries to the project dependencies? Is it ok to add the following to pyproject.toml

  "pyrate-limiter>=3.7.1",
  "hishel>=0.1.3"

[paultiq]

Yes, that's good/ready.

[paultiq]

To conclude this:

Merged in 4.6.0. Caching implementation is here: https://github.com/dgunning/edgartools/blob/main/edgar/httpclient_cache.py