diff options
Diffstat (limited to 'venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info')
6 files changed, 180 insertions, 0 deletions
diff --git a/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/INSTALLER b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/INSTALLER new file mode 100644 index 0000000..a1b589e --- /dev/null +++ b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/INSTALLER @@ -0,0 +1 @@ +pip diff --git a/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/LICENSE b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/LICENSE new file mode 100644 index 0000000..79a03ca --- /dev/null +++ b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2015 MagicStack Inc. http://magic.io + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/METADATA b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/METADATA new file mode 100644 index 0000000..0e9434e --- /dev/null +++ b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/METADATA @@ -0,0 +1,133 @@ +Metadata-Version: 2.1 +Name: httptools +Version: 0.6.1 +Summary: A collection of framework independent HTTP protocol utils. +Home-page: https://github.com/MagicStack/httptools +Author: Yury Selivanov +Author-email: yury@magic.io +License: MIT +Platform: macOS +Platform: POSIX +Platform: Windows +Classifier: License :: OSI Approved :: MIT License +Classifier: Intended Audience :: Developers +Classifier: Programming Language :: Python :: 3 +Classifier: Operating System :: POSIX +Classifier: Operating System :: MacOS :: MacOS X +Classifier: Environment :: Web Environment +Classifier: Development Status :: 5 - Production/Stable +Requires-Python: >=3.8.0 +Description-Content-Type: text/markdown +License-File: LICENSE +Provides-Extra: test +Requires-Dist: Cython <0.30.0,>=0.29.24 ; extra == 'test' + +![Tests](https://github.com/MagicStack/httptools/workflows/Tests/badge.svg) + +httptools is a Python binding for the nodejs HTTP parser. + +The package is available on PyPI: `pip install httptools`. + + +# APIs + +httptools contains two classes `httptools.HttpRequestParser`, +`httptools.HttpResponseParser` (fulfilled through +[llhttp](https://github.com/nodejs/llhttp)) and a function for +parsing URLs `httptools.parse_url` (through +[http-parse](https://github.com/nodejs/http-parser) for now). +See unittests for examples. + + +```python + +class HttpRequestParser: + + def __init__(self, protocol): + """HttpRequestParser + + protocol -- a Python object with the following methods + (all optional): + + - on_message_begin() + - on_url(url: bytes) + - on_header(name: bytes, value: bytes) + - on_headers_complete() + - on_body(body: bytes) + - on_message_complete() + - on_chunk_header() + - on_chunk_complete() + - on_status(status: bytes) + """ + + def get_http_version(self) -> str: + """Return an HTTP protocol version.""" + + def should_keep_alive(self) -> bool: + """Return ``True`` if keep-alive mode is preferred.""" + + def should_upgrade(self) -> bool: + """Return ``True`` if the parsed request is a valid Upgrade request. + The method exposes a flag set just before on_headers_complete. + Calling this method earlier will only yield `False`. + """ + + def feed_data(self, data: bytes): + """Feed data to the parser. + + Will eventually trigger callbacks on the ``protocol`` + object. + + On HTTP upgrade, this method will raise an + ``HttpParserUpgrade`` exception, with its sole argument + set to the offset of the non-HTTP data in ``data``. + """ + + def get_method(self) -> bytes: + """Return HTTP request method (GET, HEAD, etc)""" + + +class HttpResponseParser: + + """Has all methods except ``get_method()`` that + HttpRequestParser has.""" + + def get_status_code(self) -> int: + """Return the status code of the HTTP response""" + + +def parse_url(url: bytes): + """Parse URL strings into a structured Python object. + + Returns an instance of ``httptools.URL`` class with the + following attributes: + + - schema: bytes + - host: bytes + - port: int + - path: bytes + - query: bytes + - fragment: bytes + - userinfo: bytes + """ +``` + + +# Development + +1. Clone this repository with + `git clone --recursive git@github.com:MagicStack/httptools.git` + +2. Create a virtual environment with Python 3: + `python3 -m venv envname` + +3. Activate the environment with `source envname/bin/activate` + +4. Install development requirements with `pip install -e .[test]` + +5. Run `make` and `make test`. + + +# License + +MIT. diff --git a/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/RECORD b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/RECORD new file mode 100644 index 0000000..b72f722 --- /dev/null +++ b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/RECORD @@ -0,0 +1,16 @@ +httptools-0.6.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+httptools-0.6.1.dist-info/LICENSE,sha256=9Fc-fLdnZ0X7W402-lSKqT45HPtoct2s1lEwxF6mqS0,1093
+httptools-0.6.1.dist-info/METADATA,sha256=yIvpLxr5FrZNdk1tBXU9RYodbqYhBZDI8PMdWi5zqto,3593
+httptools-0.6.1.dist-info/RECORD,,
+httptools-0.6.1.dist-info/WHEEL,sha256=EIy-y1f6Kl7dHuX4o-aVVoTnJIPIEE15sSrvpnw7eak,225
+httptools-0.6.1.dist-info/top_level.txt,sha256=APjJKTbZcj0OQ4fdgf2eTCk82nK1n2BFXOD7ky41MPY,10
+httptools/__init__.py,sha256=plt3MIbueJdco9Dy7zoH3ksLNeyirqWagat5rwRmAjo,147
+httptools/__pycache__/__init__.cpython-311.pyc,,
+httptools/__pycache__/_version.cpython-311.pyc,,
+httptools/_version.py,sha256=y6jqAuxyG1pKIlPgz_cZ-7WvR3i3Y-D-CGlDqhaHr3M,575
+httptools/parser/__init__.py,sha256=fWyconPEHZlJojzRwmBKSn4C85OGXmKEwiEcdjHqXO8,166
+httptools/parser/__pycache__/__init__.cpython-311.pyc,,
+httptools/parser/__pycache__/errors.cpython-311.pyc,,
+httptools/parser/errors.py,sha256=ZVrtN1smPIb_opQ2Ud3uCbGlNLMlECYM2-6S7r5LnHs,566
+httptools/parser/parser.cpython-311-x86_64-linux-gnu.so,sha256=engm-Nf81vUbTTS7Y-jWSGSHzCqpijIOXDK_e76dj4I,705800
+httptools/parser/url_parser.cpython-311-x86_64-linux-gnu.so,sha256=wakDQKijT0AWibOzkPcniZCrRSa3MGKWo_uKl3JT9qw,319392
diff --git a/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/WHEEL b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/WHEEL new file mode 100644 index 0000000..7402ce8 --- /dev/null +++ b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/WHEEL @@ -0,0 +1,8 @@ +Wheel-Version: 1.0 +Generator: bdist_wheel (0.41.2) +Root-Is-Purelib: false +Tag: cp311-cp311-manylinux_2_5_x86_64 +Tag: cp311-cp311-manylinux1_x86_64 +Tag: cp311-cp311-manylinux_2_17_x86_64 +Tag: cp311-cp311-manylinux2014_x86_64 + diff --git a/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/top_level.txt b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/top_level.txt new file mode 100644 index 0000000..bef3b40 --- /dev/null +++ b/venv/lib/python3.11/site-packages/httptools-0.6.1.dist-info/top_level.txt @@ -0,0 +1 @@ +httptools |