k3httpmultipart 0.1.0__tar.gz → 0.1.2__tar.gz

k3httpmultipart-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 张炎泼
+
+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.

k3httpmultipart-0.1.2/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: k3httpmultipart
+Version: 0.1.2
+Summary: HTTP multipart form data encoder
+Author-email: Zhang Yanpo <drdr.xp@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/pykit3/k3httpmultipart
+Project-URL: Documentation, https://k3httpmultipart.readthedocs.io
+Keywords: http,multipart,form-data,upload
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: k3mime
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: k3fs; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+Requires-Dist: pk3; extra == "publish"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
+Dynamic: license-file
+
+# k3httpmultipart
+
+[![Action-CI](https://github.com/pykit3/k3httpmultipart/actions/workflows/python-package.yml/badge.svg)](https://github.com/pykit3/k3httpmultipart/actions/workflows/python-package.yml)
+[![Build Status](https://travis-ci.com/pykit3/k3httpmultipart.svg?branch=master)](https://travis-ci.com/pykit3/k3httpmultipart)
+[![Documentation Status](https://readthedocs.org/projects/k3httpmultipart/badge/?version=stable)](https://k3httpmultipart.readthedocs.io/en/stable/?badge=stable)
+[![Package](https://img.shields.io/pypi/pyversions/k3httpmultipart)](https://pypi.org/project/k3httpmultipart)
+
+This module provides some util methods to get multipart headers and body.
+
+k3httpmultipart is a component of [pykit3] project: a python3 toolkit set.
+
+
+#   Name
+
+k3httpmultipart
+
+#   Status
+
+The library is considered production ready.
+
+
+
+
+# Install
+
+```
+pip install k3httpmultipart
+```
+
+# Synopsis
+
+```python
+
+import os
+
+import k3httpmultipart
+import k3fs
+
+# http request headers
+headers = {'Content-Length': 1200}
+
+# http request fields
+file_path = '/tmp/abc.txt'
+k3fs.fwrite(file_path, '123456789')
+fields = [
+    {
+        'name': 'aaa',
+        'value': 'abcde',
+    },
+    {
+        'name': 'bbb',
+        'value': [open(file_path), os.path.getsize(file_path), 'abc.txt']
+    },
+]
+
+# get http request headers
+multipart = k3httpmultipart.Multipart()
+res_headers = multipart.make_headers(fields, headers=headers)
+
+print(res_headers)
+
+#output:
+#{
+#    'Content-Type': 'multipart/form-data; boundary=FormBoundaryrGKCBY7',
+#    'Conetnt-Length': 1200,
+#}
+
+# get http request body reader
+multipart = k3httpmultipart.Multipart()
+body_reader = multipart.make_body_reader(fields)
+data = []
+
+for body in body_reader:
+    data.append(body)
+
+print(''.join(data))
+
+#output:
+#--FormBoundaryrGKCBY7
+#Content-Disposition: form-data; name=aaa
+#
+#abcde
+#--FormBoundaryrGKCBY7
+#Content-Disposition: form-data; name=bbb; filename=abc.txt
+#Content-Type: text/plain
+#
+#123456789
+#--FormBoundaryrGKCBY7--
+
+```
+
+#   Author
+
+Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+#   Copyright and License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+
+[pykit3]: https://github.com/pykit3

k3httpmultipart-0.1.2/README.md

@@ -0,0 +1,103 @@
+# k3httpmultipart
+
+[![Action-CI](https://github.com/pykit3/k3httpmultipart/actions/workflows/python-package.yml/badge.svg)](https://github.com/pykit3/k3httpmultipart/actions/workflows/python-package.yml)
+[![Build Status](https://travis-ci.com/pykit3/k3httpmultipart.svg?branch=master)](https://travis-ci.com/pykit3/k3httpmultipart)
+[![Documentation Status](https://readthedocs.org/projects/k3httpmultipart/badge/?version=stable)](https://k3httpmultipart.readthedocs.io/en/stable/?badge=stable)
+[![Package](https://img.shields.io/pypi/pyversions/k3httpmultipart)](https://pypi.org/project/k3httpmultipart)
+
+This module provides some util methods to get multipart headers and body.
+
+k3httpmultipart is a component of [pykit3] project: a python3 toolkit set.
+
+
+#   Name
+
+k3httpmultipart
+
+#   Status
+
+The library is considered production ready.
+
+
+
+
+# Install
+
+```
+pip install k3httpmultipart
+```
+
+# Synopsis
+
+```python
+
+import os
+
+import k3httpmultipart
+import k3fs
+
+# http request headers
+headers = {'Content-Length': 1200}
+
+# http request fields
+file_path = '/tmp/abc.txt'
+k3fs.fwrite(file_path, '123456789')
+fields = [
+    {
+        'name': 'aaa',
+        'value': 'abcde',
+    },
+    {
+        'name': 'bbb',
+        'value': [open(file_path), os.path.getsize(file_path), 'abc.txt']
+    },
+]
+
+# get http request headers
+multipart = k3httpmultipart.Multipart()
+res_headers = multipart.make_headers(fields, headers=headers)
+
+print(res_headers)
+
+#output:
+#{
+#    'Content-Type': 'multipart/form-data; boundary=FormBoundaryrGKCBY7',
+#    'Conetnt-Length': 1200,
+#}
+
+# get http request body reader
+multipart = k3httpmultipart.Multipart()
+body_reader = multipart.make_body_reader(fields)
+data = []
+
+for body in body_reader:
+    data.append(body)
+
+print(''.join(data))
+
+#output:
+#--FormBoundaryrGKCBY7
+#Content-Disposition: form-data; name=aaa
+#
+#abcde
+#--FormBoundaryrGKCBY7
+#Content-Disposition: form-data; name=bbb; filename=abc.txt
+#Content-Type: text/plain
+#
+#123456789
+#--FormBoundaryrGKCBY7--
+
+```
+
+#   Author
+
+Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+#   Copyright and License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+
+[pykit3]: https://github.com/pykit3

k3httpmultipart-0.1.2/__init__.py

@@ -0,0 +1,15 @@
+from importlib.metadata import version
+
+__version__ = version("k3httpmultipart")
+
+from .multipart import (
+    Multipart,
+    InvalidArgumentTypeError,
+    MultipartError,
+)
+
+__all__ = [
+    "Multipart",
+    "InvalidArgumentTypeError",
+    "MultipartError",
+]

k3httpmultipart-0.1.2/k3httpmultipart.egg-info/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: k3httpmultipart
+Version: 0.1.2
+Summary: HTTP multipart form data encoder
+Author-email: Zhang Yanpo <drdr.xp@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/pykit3/k3httpmultipart
+Project-URL: Documentation, https://k3httpmultipart.readthedocs.io
+Keywords: http,multipart,form-data,upload
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: k3mime
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: k3fs; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+Requires-Dist: pk3; extra == "publish"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
+Dynamic: license-file
+
+# k3httpmultipart
+
+[![Action-CI](https://github.com/pykit3/k3httpmultipart/actions/workflows/python-package.yml/badge.svg)](https://github.com/pykit3/k3httpmultipart/actions/workflows/python-package.yml)
+[![Build Status](https://travis-ci.com/pykit3/k3httpmultipart.svg?branch=master)](https://travis-ci.com/pykit3/k3httpmultipart)
+[![Documentation Status](https://readthedocs.org/projects/k3httpmultipart/badge/?version=stable)](https://k3httpmultipart.readthedocs.io/en/stable/?badge=stable)
+[![Package](https://img.shields.io/pypi/pyversions/k3httpmultipart)](https://pypi.org/project/k3httpmultipart)
+
+This module provides some util methods to get multipart headers and body.
+
+k3httpmultipart is a component of [pykit3] project: a python3 toolkit set.
+
+
+#   Name
+
+k3httpmultipart
+
+#   Status
+
+The library is considered production ready.
+
+
+
+
+# Install
+
+```
+pip install k3httpmultipart
+```
+
+# Synopsis
+
+```python
+
+import os
+
+import k3httpmultipart
+import k3fs
+
+# http request headers
+headers = {'Content-Length': 1200}
+
+# http request fields
+file_path = '/tmp/abc.txt'
+k3fs.fwrite(file_path, '123456789')
+fields = [
+    {
+        'name': 'aaa',
+        'value': 'abcde',
+    },
+    {
+        'name': 'bbb',
+        'value': [open(file_path), os.path.getsize(file_path), 'abc.txt']
+    },
+]
+
+# get http request headers
+multipart = k3httpmultipart.Multipart()
+res_headers = multipart.make_headers(fields, headers=headers)
+
+print(res_headers)
+
+#output:
+#{
+#    'Content-Type': 'multipart/form-data; boundary=FormBoundaryrGKCBY7',
+#    'Conetnt-Length': 1200,
+#}
+
+# get http request body reader
+multipart = k3httpmultipart.Multipart()
+body_reader = multipart.make_body_reader(fields)
+data = []
+
+for body in body_reader:
+    data.append(body)
+
+print(''.join(data))
+
+#output:
+#--FormBoundaryrGKCBY7
+#Content-Disposition: form-data; name=aaa
+#
+#abcde
+#--FormBoundaryrGKCBY7
+#Content-Disposition: form-data; name=bbb; filename=abc.txt
+#Content-Type: text/plain
+#
+#123456789
+#--FormBoundaryrGKCBY7--
+
+```
+
+#   Author
+
+Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+#   Copyright and License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Zhang Yanpo (张炎泼) <drdr.xp@gmail.com>
+
+
+[pykit3]: https://github.com/pykit3

k3httpmultipart-0.1.2/k3httpmultipart.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+__init__.py
+multipart.py
+pyproject.toml
+synopsis.py
+./__init__.py
+./multipart.py
+./synopsis.py
+k3httpmultipart.egg-info/PKG-INFO
+k3httpmultipart.egg-info/SOURCES.txt
+k3httpmultipart.egg-info/dependency_links.txt
+k3httpmultipart.egg-info/requires.txt
+k3httpmultipart.egg-info/top_level.txt
+test/test_doctest.py
+test/test_k3httpmultipart.py

k3httpmultipart-0.1.2/k3httpmultipart.egg-info/requires.txt

@@ -0,0 +1,17 @@
+k3mime
+
+[dev]
+pytest>=7.0
+ruff
+coverage
+k3fs
+
+[docs]
+mkdocs>=1.5
+mkdocs-material>=9.0
+mkdocstrings[python]>=0.24
+
+[publish]
+build
+twine
+pk3

k3httpmultipart-0.1.2/multipart.py

@@ -0,0 +1,185 @@
+import uuid
+import copy
+
+import k3mime
+from collections.abc import Iterator
+
+
+class MultipartError(Exception):
+    # The base class of the other exceptions in this module. It is a subclass of `Exception`
+    pass
+
+
+class InvalidArgumentTypeError(MultipartError):
+    # A subclass of `MultipartError` Raise if the type of value is not a str or a list or the type of value[0] is not a string, string reader, file reader or file object
+    pass
+
+
+class Multipart(object):
+    """
+
+    :param block_size: It represents the size of each reading file
+    :param boundary: a placeholder that represents out specified delimiter
+    """
+
+    def __init__(self, block_size=1024 * 1024):
+        self.block_size = block_size
+
+        self.boundary = uuid.uuid4().hex
+
+        self.delimiter = "--{b}".format(b=self.boundary)
+        self.terminator = "--{b}--".format(b=self.boundary)
+
+    def make_headers(self, fields, headers=None):
+        """
+            Return a header according to the fields and headers
+
+            :param fields: is a list of the dict, and each elements contains `name`, `value` and `headers`,
+        `headers` is an optional argument
+                -   `name`:
+                It's a string that represents field's name
+
+                -   `value`:
+                The value represents field's content. The type of value can be a string or a
+                list, string indicates that the field is a normal string, However, there are
+                three arguments of list: `content`, `size` and `file_name`
+
+                    -   `content`:
+                    The type of `content` can be string, reader, file object
+                        The string type refers to the user want to upload a string. It takes the
+                    string as the field body
+
+                        The reader type refers to a generator. To read the contents of generator as
+                    the field body
+
+                        The file object type refers to a file object, To read the contents of file
+                    as the field body
+
+                    -   `size`
+                    `size` refers to the length of the content, When the type of `content` is a
+                    string, size can be None
+
+                    - `file_name`
+                    `file_name` is an optional argument, if `file_name` is None, that indicates
+                    that `content` is uploaded as a normal field, whereas, the field as a file
+
+                -   `headers`:
+                a dict, key is the `field_header_name`, value is the `field_header_value`,
+                it contains user defined headers and the required headers, such as
+                'Content-Disposition' and 'Content-Type'
+            :param headers: a dict of http request headers, key is the `header_name`, value is the
+        `header_value`.  It's a default argument and its default value is None
+            :return: a dict that represents the request headers
+        """
+
+        if headers is None:
+            headers = {}
+        else:
+            headers = copy.deepcopy(headers)
+
+        headers["Content-Type"] = "multipart/form-data; boundary={b}".format(b=self.boundary)
+
+        if "Content-Length" not in headers:
+            headers["Content-Length"] = self._get_body_size(fields)
+
+        return headers
+
+    def make_body_reader(self, fields):
+        """
+        Return a body according to the fields
+
+        :param fields: refer to the explanation above fields
+        :return: a generator that represents the multipart request body
+        """
+
+        for f in fields:
+            reader, fsize, headers = self._standardize_field(f["name"], f["value"], f.get("headers", {}))
+
+            yield self._get_field_header(headers)
+
+            for buf in reader:
+                yield buf
+
+            yield "\r\n"
+
+        yield self.terminator
+
+    def _standardize_field(self, name, value, headers):
+        if isinstance(value, str):
+            reader = self._make_str_reader(value)
+            fsize = len(value)
+            self._set_content_disposition(headers, name)
+
+            return reader, fsize, headers
+
+        elif isinstance(value, list):
+            reader, fsize, fname = self._standardize_value(value)
+
+            self._set_content_disposition(headers, name, fname)
+            if fname is not None:
+                headers.setdefault("Content-Type", k3mime.get_by_filename(fname))
+
+            return reader, fsize, headers
+
+        raise InvalidArgumentTypeError("type of value {x} is invalid".format(x=type(value)))
+
+    def _standardize_value(self, value):
+        reader, fsize, fname = (value + [None, None])[:3]
+
+        if isinstance(reader, type(open)):
+            reader = self._make_file_reader(reader)
+
+        elif isinstance(reader, str):
+            reader = self._make_str_reader(reader)
+            fsize = len(value[0])
+
+        elif isinstance(reader, Iterator):
+            pass
+
+        else:
+            raise InvalidArgumentTypeError("type of value[0] {x}is invalid".format(x=type(value[0])))
+
+        return reader, fsize, fname
+
+    def _get_field_size(self, field):
+        reader, fsize, headers = self._standardize_field(field["name"], field["value"], field.get("headers", {}))
+
+        field_headers = self._get_field_header(headers)
+
+        return len(field_headers) + fsize + len("\r\n")
+
+    def _get_body_size(self, fields):
+        body_size = 0
+
+        for f in fields:
+            body_size += self._get_field_size(f)
+
+        return body_size + len(self.terminator)
+
+    def _get_field_header(self, headers):
+        field_headers = [self.delimiter]
+
+        field_headers.append("Content-Disposition: " + headers.pop("Content-Disposition"))
+
+        for k, v in headers.items():
+            field_headers.append(k + ": " + v)
+
+        field_headers.extend([""] * 2)
+
+        return "\r\n".join(field_headers)
+
+    def _make_file_reader(self, file_object):
+        while True:
+            buf = file_object.read(self.block_size)
+            if buf == "":
+                break
+            yield buf
+
+    def _make_str_reader(self, data):
+        yield data
+
+    def _set_content_disposition(self, headers, name, fname=None):
+        if fname is None:
+            headers["Content-Disposition"] = "form-data; name={n}".format(n=name)
+        else:
+            headers["Content-Disposition"] = "form-data; name={n}; filename={fn}".format(n=name, fn=fname)

k3httpmultipart-0.1.2/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "k3httpmultipart"
+version = "0.1.2"
+description = "HTTP multipart form data encoder"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+authors = [
+    { name = "Zhang Yanpo", email = "drdr.xp@gmail.com" }
+]
+keywords = ["http", "multipart", "form-data", "upload"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "k3mime",
+]
+
+[project.urls]
+Homepage = "https://github.com/pykit3/k3httpmultipart"
+Documentation = "https://k3httpmultipart.readthedocs.io"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "ruff",
+    "coverage",
+    "k3fs",
+]
+publish = [
+    "build",
+    "twine",
+    "pk3",
+]
+docs = [
+    "mkdocs>=1.5",
+    "mkdocs-material>=9.0",
+    "mkdocstrings[python]>=0.24",
+]
+
+[tool.setuptools]
+packages = ["k3httpmultipart"]
+
+[tool.setuptools.package-dir]
+k3httpmultipart = "."
+
+[tool.ruff]
+line-length = 120