fastpybase64 0.1.0__tar.gz

fastpybase64-0.1.0/LICENSE-APACHE

@@ -0,0 +1,201 @@
+              Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 The simdutf authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fastpybase64-0.1.0/LICENSE-MIT

@@ -0,0 +1,18 @@
+Copyright (c) 2026 Daniel Lemire
+
+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.

fastpybase64-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include vendor/*.h vendor/*.cpp vendor/simdutf-LICENSE-* src/*.cpp
+include bench.py doc/make_charts.py
+recursive-include tests *.py

fastpybase64-0.1.0/PKG-INFO

@@ -0,0 +1,263 @@
+Metadata-Version: 2.4
+Name: fastpybase64
+Version: 0.1.0
+Summary: Fast Base64 encoding and decoding for Python, built on simdutf
+Author-email: Daniel Lemire <daniel@lemire.me>
+License-Expression: Apache-2.0 OR MIT
+Project-URL: Homepage, https://github.com/simdutf/fastpybase64
+Project-URL: Repository, https://github.com/simdutf/fastpybase64
+Project-URL: Issues, https://github.com/simdutf/fastpybase64/issues
+Keywords: base64,simdutf,simd,performance,encoding
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Free Threading :: 2 - Beta
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+License-File: vendor/simdutf-LICENSE-APACHE
+License-File: vendor/simdutf-LICENSE-MIT
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: bench
+Requires-Dist: pybase64; extra == "bench"
+Dynamic: license-file
+
+# fastpybase64
+
+[![Tests](https://github.com/simdutf/fastpybase64/actions/workflows/tests.yml/badge.svg)](https://github.com/simdutf/fastpybase64/actions/workflows/tests.yml)
+
+A Python binding for the base64 functions of
+[simdutf](https://github.com/simdutf/simdutf), the library that Node.js uses
+for base64. It is a drop-in replacement for the standard
+library's `base64` module: every function returns the same bytes and raises
+the same exceptions as its counterpart in `base64`, for every input. It
+decodes up to 80 times faster than the standard library and up to 13 times
+faster than [pybase64](https://github.com/mayeut/pybase64), and it is
+several times faster than both on small inputs.
+
+With pip:
+
+```sh
+pip install fastpybase64
+```
+
+With uv:
+
+```sh
+uv pip install fastpybase64      # in a uv project: uv add fastpybase64
+```
+
+Wheels are built for Linux, macOS and Windows, for Python 3.10 to 3.14,
+including free-threaded Python 3.14.
+
+## Usage
+
+```python
+import fastpybase64 as base64
+
+base64.b64encode(b"hello")                     # b'aGVsbG8='
+base64.b64decode("aGVsbG8=")                   # b'hello'
+base64.b64decode(b"aGVsbG8=", validate=True)   # b'hello'
+base64.urlsafe_b64encode(b"\xfb\xff")          # b'-_8='
+base64.encodebytes(data)                       # MIME: lines of 76 characters
+```
+
+| function | |
+|---|---|
+| `b64encode(s, altchars=None)` | standard alphabet, or any two replacement characters for `+` and `/` |
+| `b64decode(s, altchars=None, validate=False)` | |
+| `standard_b64encode(s)`, `standard_b64decode(s)` | |
+| `urlsafe_b64encode(s)`, `urlsafe_b64decode(s)` | alphabet with `-` and `_` |
+| `encodebytes(s)`, `decodebytes(s)` | MIME style: a newline after every 76 characters |
+| `get_implementation()` | the kernel simdutf selected for this processor (`icelake`, `haswell`, `arm64`, ...) |
+| `simdutf_version`, `__version__` | versions of simdutf and of fastpybase64 |
+
+The functions accept what `base64` accepts: `bytes`, `bytearray`,
+`memoryview` and other buffers, and ASCII `str` for the decoders.
+
+### Same results as `base64`
+
+simdutf decodes base64 following the WHATWG forgiving-base64 rules, used by
+`atob` in web browsers. These rules differ from those of Python's `binascii`
+module: simdutf skips ASCII spaces and accepts missing padding, whereas the
+standard library requires padding and, with `validate=True`, rejects spaces.
+fastpybase64 keeps Python's behavior. Each call decodes with simdutf, then a
+cheap check confirms that `base64` would return the same bytes for this
+input. When it cannot confirm it, fastpybase64 calls `base64` with the same
+arguments and returns its result or lets its exception propagate. So invalid
+input raises exactly the `binascii.Error` that `base64` would raise, with
+the same message, and the rare inputs where `base64` is lenient in odd ways
+(characters after the padding, for example) give the same bytes.
+
+* With `validate=False` (the default), spaces, newlines and other characters
+  outside the alphabet are ignored, as in `base64`. simdutf skips spaces and
+  line breaks while it decodes: 1 MiB of MIME data (a newline every 76
+  characters) decodes at 12.0 GB/s on an Apple M4 Max, against 14.3 GB/s
+  without newlines (pybase64: 4.1 GB/s, `base64`: 1.3 GB/s).
+* With `validate=True`, any character outside the alphabet, including a
+  space or a newline, raises `binascii.Error`.
+* Characters after the padding are handled as in the version of Python you
+  run: Python 3.13 and earlier stop decoding at the padding, Python 3.14
+  continues or raises.
+* `urlsafe_b64decode`, like the standard library, accepts both alphabets
+  (`+/` and `-_`).
+* An `altchars` other than `b"+/"` and `b"-_"` is handled by encoding with
+  simdutf and then replacing the two characters; decoding with such an
+  alphabet is left to `base64`.
+
+### Threads
+
+The GIL is released while encoding or decoding 64 KiB or more, so several
+threads can work at once. The module is marked free-threading compatible
+(`Py_MOD_GIL_NOT_USED`), so importing it on a free-threaded build of Python
+does not enable the GIL. Do not change a `bytearray` while another thread
+encodes or decodes it: the result would be unpredictable (its size cannot
+change, so memory stays safe).
+
+## Build and test
+
+Python 3.10 or newer, and a C++17 compiler (clang, GCC or MSVC). The simdutf
+9.3.1 amalgamation is in `vendor/`. Only its base64 functions are compiled
+(see `setup.py`).
+
+pip:
+
+```sh
+python3 -m venv .venv
+. .venv/bin/activate
+python -m pip install -U pip
+python -m pip install -e ".[test]"
+pytest tests
+```
+
+uv:
+
+```sh
+uv venv
+. .venv/bin/activate
+uv pip install -e ".[test]"
+pytest tests
+```
+
+The tests compare every function with `base64`, results and exceptions, on
+inputs of every length from 0 to 199 bytes and larger ones, on the edge cases
+of padding and of characters outside the alphabet, on every supported input
+type, on wrong arguments, and on thousands of randomly corrupted inputs.
+
+`bench.py` compares fastpybase64 with `base64` and pybase64 (the `bench`
+extra) from 16 bytes to 16 MiB:
+
+```sh
+python -m pip install -e ".[bench]"
+python bench.py
+python bench.py --sizes 64,4096,65536 --ops b64encode,b64decode
+```
+
+## Benchmarks
+
+Intel Xeon Gold 6548N (Emerald Rapids), one core, Python 3.14.6,
+fastpybase64 0.1.0 (simdutf 9.3.1, `icelake` kernel), pybase64 1.5.1 (its
+AVX512VBMI kernel), random bytes. Speeds are in GB/s of binary data, for
+encoding and decoding alike (higher is better).
+
+### Decoding
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/simdutf/fastpybase64/main/doc/perf_decode_dark.png">
+  <img src="https://raw.githubusercontent.com/simdutf/fastpybase64/main/doc/perf_decode.png" width="80%" alt="Decoding 64 KiB: fastpybase64 b64decode 32.66 GB/s, fastpybase64 validate=True 30.81, pybase64 validate=True 14.65, pybase64 b64decode 3.44, base64 validate=True 0.55, base64 b64decode 0.50">
+</picture>
+
+| function | size | `base64` | pybase64 | fastpybase64 |
+|---|---:|---:|---:|---:|
+| `b64decode` | 64 B | 0.24 | 0.44 | **0.96** |
+| | 4 KiB | 0.48 | 3.06 | **22.42** |
+| | 64 KiB | 0.50 | 3.44 | **32.66** |
+| | 1 MiB | 0.50 | 3.47 | **19.38** |
+| `b64decode(validate=True)` | 64 B | 0.19 | 0.23 | **0.43** |
+| | 4 KiB | 0.53 | 7.25 | **14.61** |
+| | 64 KiB | 0.55 | 14.65 | **30.81** |
+| | 1 MiB | 0.55 | 15.24 | **19.55** |
+| `urlsafe_b64decode` | 64 B | 0.16 | 0.16 | **0.98** |
+| | 64 KiB | 0.41 | 2.52 | **33.86** |
+| `decodebytes` | 64 KiB | 0.49 | | **12.10** |
+
+pybase64 is fast only with `validate=True`; by default (`validate=False`, as
+in `base64`) and in `urlsafe_b64decode`, it is 4 to 13 times slower than
+fastpybase64 from 4 KiB on. pybase64 has no
+`decodebytes`.
+
+### Encoding
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/simdutf/fastpybase64/main/doc/perf_encode_dark.png">
+  <img src="https://raw.githubusercontent.com/simdutf/fastpybase64/main/doc/perf_encode.png" width="80%" alt="Encoding 64 KiB: pybase64 b64encode 32.46 GB/s, fastpybase64 b64encode 30.68, fastpybase64 urlsafe_b64encode 30.31, pybase64 urlsafe_b64encode 9.84, base64 b64encode 0.98, base64 urlsafe_b64encode 0.69">
+</picture>
+
+| function | size | `base64` | pybase64 | fastpybase64 |
+|---|---:|---:|---:|---:|
+| `b64encode` | 64 B | 0.43 | 0.39 | **1.34** |
+| | 4 KiB | 0.95 | 16.15 | **31.18** |
+| | 64 KiB | 0.98 | 32.46 | 30.68 |
+| | 1 MiB | 0.75 | 18.43 | 17.92 |
+| `urlsafe_b64encode` | 64 B | 0.30 | 0.21 | **1.34** |
+| | 64 KiB | 0.69 | 9.84 | **30.31** |
+| `encodebytes` | 64 B | 0.11 | 0.50 | **1.29** |
+| | 64 KiB | 0.38 | 1.18 | **22.20** |
+
+From 64 KiB on, `b64encode` runs at the same speed in pybase64 and
+fastpybase64: both use the same AVX-512 algorithm, and which one is ahead
+changes from run to run (within 6%). On smaller inputs, and for the URL-safe
+alphabet and MIME line breaks, fastpybase64 is faster.
+
+### Small inputs
+
+On small inputs, the cost of the call dominates. fastpybase64 parses its
+arguments without creating objects and writes the result directly into the
+`bytes` object it returns.
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/simdutf/fastpybase64/main/doc/perf_small_dark.png">
+  <img src="https://raw.githubusercontent.com/simdutf/fastpybase64/main/doc/perf_small.png" width="80%" alt="Time per call for 64 bytes: fastpybase64 b64encode 48 ns, pybase64 164 ns, base64 149 ns; fastpybase64 b64decode 67 ns, pybase64 145 ns, base64 267 ns">
+</picture>
+
+### Apple M4 Max
+
+macOS, Python 3.14.5, simdutf's `arm64` (NEON) kernel, pybase64 with its
+NEON kernel. GB/s:
+
+| function | size | `base64` | pybase64 | fastpybase64 |
+|---|---:|---:|---:|---:|
+| `b64encode` | 64 B | 0.56 | 0.77 | **1.62** |
+| | 64 KiB | 1.13 | 23.30 | **23.70** |
+| `b64decode` | 64 B | 0.33 | 0.61 | **1.16** |
+| | 64 KiB | 0.92 | 4.23 | **13.94** |
+| `b64decode(validate=True)` | 64 KiB | 0.95 | 12.16 | **13.71** |
+| `urlsafe_b64decode` | 64 KiB | 0.71 | 3.06 | **13.00** |
+| `encodebytes` | 64 KiB | 0.47 | 8.53 | **12.82** |
+
+## Releases
+
+`./release.sh X.Y.Z` sets the version in `pyproject.toml` and
+`src/fastpybase64.cpp`, runs the tests in a fresh virtual environment,
+commits, tags `vX.Y.Z` and pushes. The tag starts the `buildwheels` workflow,
+which builds the wheels and the source distribution and uploads them to PyPI.
+
+## References
+
+* Daniel Lemire, [Fast Forgiving Base64 Decoding with SIMD Instructions](https://dl.acm.org/doi/10.1145/3859286), ACM Transactions on Architecture and Code Optimization, 2026.
+* Wojciech Muła, Daniel Lemire, [Base64 encoding and decoding at almost the speed of a memory copy](https://arxiv.org/abs/1910.05109), Software: Practice and Experience 50 (2), 2020.
+* Wojciech Muła, Daniel Lemire, [Faster Base64 Encoding and Decoding using AVX2 Instructions](https://arxiv.org/abs/1704.00605), ACM Transactions on the Web 12 (3), 2018.
+
+## License
+
+Apache-2.0 or MIT, at your option, like simdutf.