Case insensitive HTTPHeaders, HTTPResponse context manager and some fixes #29

michalpokusa · 2022-12-19T21:11:30Z

Added separate class for HTTP headers, that allows accessing headers using case-insensitive names.

Also, changed some docstrings the were unclear and one that was misleading as it was inconsistent with the code.

Changed the order of Docs References, so that the most "important" ones are on the top, with enums and dataclass-like classes below.

Updated library version to 1.1.0 in sphinx configuration file.

Fixes #26
Fixes #28

adafruit_httpserver/response.py

anecdata · 2022-12-22T15:42:13Z

@michalpokusa Any thoughts on this 404 issue? #28 (comment) I don't see anything obvious in this PR that would have affected it. Maybe it came in with the refactor and just wasn't noticed until now. Worth a separate issue?

michalpokusa · 2022-12-22T18:04:06Z

@michalpokusa Any thoughts on this 404 issue? #28 (comment) I don't see anything obvious in this PR that would have affected it. Maybe it came in with the refactor and just wasn't noticed until now. Worth a separate issue?

Working on it, also I see that other PR was merged and there are merge conflicts, so I will fix both before proceeding

michalpokusa · 2022-12-23T12:24:33Z

After merging recently updated main branch i noticed some inconsistencies wit hthe HTTPResponse API, mainy the fact that some function would accept conn and some not. Also in chunked response sending headers and empty chunk to finish transfer should be implicit.

I decided to modify the HTTPResposne API to be unified by using context managers, by doings so i was able to reduce abstraction and number of lines of actual code, the PR may not show this as I added/extended some docstrings.

Also fixed the 404 problem in #28.

Using context managers all of the examples below are allowed.

paul-1 · 2022-12-23T12:57:34Z

That for sure looks a lot cleaner. Thanks for doing that

…rror if handler returns HTTPResponse

michalpokusa · 2022-12-26T13:25:53Z

In the meantime I updated examples to new "context manager way" of serving response. Did some testing on my own and I believe that it works as it should. Also I added raising error if someone tries to use .send() or .send_file() multiple times per response.

paul-1

I tested my use cases, and everything seemed to work fine, with exception of sending html in chunked mode.

adafruit_httpserver/response.py

michalpokusa · 2023-01-02T15:52:01Z

@anecdata Could be please take a look at the current state of this PR. I believe there is everything I wanted to add and that it is ready to be merged.

In the c758e51 commit I also "included" the #30.

anecdata

Tested file serving, GET, POST, a couple of MIME types, custom HTTP status code, chunked and non-chunked response bodies, multi-byte characters in response, accessing the client address.

This is a pretty large change in API, so we should change the version number accordingly.

This looks good to me, one minor thing.

adafruit_httpserver/request.py

…le naming

…ibraries

anecdata

Thanks, @michalpokusa. And thanks @bill88t for #30 included here.

dhalbert · 2023-01-02T18:26:01Z

This should be 2.0.0 if there are incompatible API or use changes. A major version change means a code rewrite is needed.

michalpokusa · 2023-01-02T18:29:33Z

This should be 2.0.0 if there are incompatible API or use changes. A major version change means a code rewrite is needed.

If I understand correctly, the code stays the same, only tag changes, so no further edits are needed on my part to make it 2.0.0

bill88t · 2023-01-02T18:31:16Z

Closing #30 then. Thanks for taking care of it!

dhalbert · 2023-01-02T18:35:55Z

If I understand correctly, the code stays the same, only tag changes, so no further edits are needed on my part to make it 2.0.0

Right, when I or whoever makes a release, it will be 2.0.0. There are incompatible API or use changes, right?

michalpokusa · 2023-01-02T18:38:28Z

There are incompatible API or use changes, right?

Yes, instead of returning HTTPResponse instance in route handlers, the function should call a method on HTTPResponse, so all handlers need to be slightly modified, but still.

dhalbert · 2023-01-02T18:44:13Z

Great - I will make a release now.

I only found one use of this library in the Learn guides:
https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/PicoW_CircuitPython_HTTP_Server/code.py
Could someone take a look at that and see if there are any changes to be made? Thanks.

michalpokusa · 2023-01-02T18:51:41Z

Great - I will make a release now.

I only found one use of this library in the Learn guides: https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/PicoW_CircuitPython_HTTP_Server/code.py Could someone take a look at that and see if there are any changes to be made? Thanks.

Thanks for merging.

Yes, there will be a small change in base and buttonpress functions. I could make the required changes, but I will be unable to test it on intended hardware as I do not own a Raspberry Pico W.

anecdata · 2023-01-02T20:22:44Z

Maybe if Liz still has it set up, it would be easy for her to test. I have a Pico W and could test the routes, but I don't have the peripherals, so I'd stub out the I/O (possibly introducing or masking an issue).

Any network code written for raspberrypi should run on espressif (but not necessarily vice versa since there are some things not implemented / not implementable).

dhalbert · 2023-01-03T01:34:57Z

If you either of you could make a draft PR, I'll test it by simplifying or setting up the base hardware. Thanks.

anecdata · 2023-01-03T02:51:43Z

adafruit/Adafruit_Learning_System_Guides#2375

Updating https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer to 2.0.0 from 1.1.0: > Merge pull request adafruit/Adafruit_CircuitPython_HTTPServer#29 from michalpokusa/httpheaders-and-some-fixes Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA: > Updated download stats for the libraries

michalpokusa added 6 commits December 19, 2022 19:35

Added HTTPHeaders

aad7010

Replacing dict with HTTPHeaders in other modules

f1878b3

Fixed and extended docstrings

d547c7f

Changed order of Docs References and updated version

d0d5b80

Fixed wrong content length for multibyte characters

d3adfd8

Black format changes

be20bb1

michalpokusa marked this pull request as ready for review December 19, 2022 21:39

anecdata reviewed Dec 19, 2022

View reviewed changes

adafruit_httpserver/response.py Outdated Show resolved Hide resolved

Encoding body only once when constructing response bytes

aeb95a2

michalpokusa marked this pull request as draft December 22, 2022 18:42

michalpokusa changed the title ~~Case insensitive HTTPHeaders and some fixes~~ Case insensitive HTTPHeaders, HTTPResponse context manager and some fixes Dec 23, 2022

michalpokusa added 3 commits December 23, 2022 11:54

Merge remote-tracking branch 'origin/main' into test

c1d2f55

Refactor for unifying the HTTPResponse API

00d3247

Changed HTTPResponse to use context managers

2ca4756

Minor changes to docstrings

a12d4ab

michalpokusa marked this pull request as ready for review December 23, 2022 18:58

Changed send_chunk_body to send_chunk for unification

c222d09

michalpokusa marked this pull request as draft December 24, 2022 06:29

michalpokusa added 5 commits December 26, 2022 01:21

Fix: Missing chunk length in ending message due to .lstrip()

4b61d74

Prevented from calling .send() multiple times and added deprecation e…

f0b61a7

…rror if handler returns HTTPResponse

Updated existing and added more examples

e2e396b

Updated README.rst

287c5e0

Fixed CI for examples/

21aa09e

michalpokusa marked this pull request as ready for review December 26, 2022 13:25

paul-1 reviewed Dec 27, 2022

View reviewed changes

adafruit_httpserver/response.py Show resolved Hide resolved

adafruit_httpserver/response.py Show resolved Hide resolved

michalpokusa added 2 commits December 28, 2022 05:51

Fix: Content type not setting properly

d14a13a

Changed root to root_path in docstrings

c758e51

Minor adjustments to examples

140c0e1

anecdata reviewed Jan 2, 2023

View reviewed changes

adafruit_httpserver/request.py Outdated Show resolved Hide resolved

michalpokusa added 2 commits January 2, 2023 17:22

Changed address to client_address to match CPython's http.server modu…

c609a82

…le naming

Changed version in docs/conf.py from 1.1.0 to 1.0, similar to other l…

5b0135a

…ibraries

anecdata approved these changes Jan 2, 2023

View reviewed changes

dhalbert merged commit e4a7e0e into adafruit:main Jan 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Case insensitive HTTPHeaders, HTTPResponse context manager and some fixes #29

Case insensitive HTTPHeaders, HTTPResponse context manager and some fixes #29

michalpokusa commented Dec 19, 2022 •

edited

Loading

anecdata commented Dec 22, 2022 •

edited

Loading

michalpokusa commented Dec 22, 2022

michalpokusa commented Dec 23, 2022 •

edited

Loading

paul-1 commented Dec 23, 2022

michalpokusa commented Dec 26, 2022

paul-1 left a comment

michalpokusa commented Jan 2, 2023

anecdata left a comment •

edited

Loading

anecdata left a comment

dhalbert commented Jan 2, 2023

michalpokusa commented Jan 2, 2023 •

edited

Loading

bill88t commented Jan 2, 2023

dhalbert commented Jan 2, 2023

michalpokusa commented Jan 2, 2023

dhalbert commented Jan 2, 2023

michalpokusa commented Jan 2, 2023 •

edited

Loading

anecdata commented Jan 2, 2023

dhalbert commented Jan 3, 2023

anecdata commented Jan 3, 2023

Case insensitive HTTPHeaders, HTTPResponse context manager and some fixes #29

Case insensitive HTTPHeaders, HTTPResponse context manager and some fixes #29

Conversation

michalpokusa commented Dec 19, 2022 • edited Loading

anecdata commented Dec 22, 2022 • edited Loading

michalpokusa commented Dec 22, 2022

michalpokusa commented Dec 23, 2022 • edited Loading

paul-1 commented Dec 23, 2022

michalpokusa commented Dec 26, 2022

paul-1 left a comment

Choose a reason for hiding this comment

michalpokusa commented Jan 2, 2023

anecdata left a comment • edited Loading

Choose a reason for hiding this comment

anecdata left a comment

Choose a reason for hiding this comment

dhalbert commented Jan 2, 2023

michalpokusa commented Jan 2, 2023 • edited Loading

bill88t commented Jan 2, 2023

dhalbert commented Jan 2, 2023

michalpokusa commented Jan 2, 2023

dhalbert commented Jan 2, 2023

michalpokusa commented Jan 2, 2023 • edited Loading

anecdata commented Jan 2, 2023

dhalbert commented Jan 3, 2023

anecdata commented Jan 3, 2023

michalpokusa commented Dec 19, 2022 •

edited

Loading

anecdata commented Dec 22, 2022 •

edited

Loading

michalpokusa commented Dec 23, 2022 •

edited

Loading

anecdata left a comment •

edited

Loading

michalpokusa commented Jan 2, 2023 •

edited

Loading

michalpokusa commented Jan 2, 2023 •

edited

Loading