transit-python 0.8.302__tar.gz → 0.8.321__tar.gz

transit_python-0.8.321/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

transit_python-0.8.321/MANIFEST.in

@@ -0,0 +1 @@
+include csrc/*.c csrc/*.h transit/_native.c

transit_python-0.8.321/PKG-INFO

@@ -0,0 +1,302 @@
+Metadata-Version: 2.4
+Name: transit-python
+Version: 0.8.321
+Summary: Transit marshalling for Python
+Author: Cognitect
+Maintainer: Vendekagon Labs LLC
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/vendekagon-labs/transit-python
+Project-URL: Issues, https://github.com/vendekagon-labs/transit-python/issues
+Project-URL: Specification, https://github.com/cognitect/transit-format
+Project-URL: Original, https://github.com/cognitect/transit-python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: msgpack
+Requires-Dist: msgpack>=1.0; extra == "msgpack"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: msgpack>=1.0; extra == "test"
+Dynamic: license-file
+
+transit-python
+==============
+
+Transit is a format and set of libraries for conveying values between
+applications written in different programming languages. The library provides
+support for marshalling data to/from Python.
+
+transit-python is maintained by [Vendekagon Labs](https://github.com/vendekagon-labs),
+which has taken it over as the successor to Cognitect's original
+[cognitect/transit-python](https://github.com/cognitect/transit-python),
+bringing it up to date: Python 3.10 and later, all three transit encodings,
+and a native extension for speed. It continues the same PyPI package,
+[`transit-python`](https://pypi.org/project/transit-python/).
+
+ * [Rationale](http://blog.cognitect.com/blog/2014/7/22/transit)
+ * [Specification](http://github.com/cognitect/transit-format)
+
+This implementation's major.minor version number corresponds to the
+version of the Transit specification it supports.
+
+_NOTE: Transit is intended primarily as a wire protocol for transferring data between applications. If storing Transit data durably, readers and writers are expected to use the same version of Transit and you are responsible for migrating/transforming/re-storing that data when and if the transit format changes._
+
+## Installation
+
+```sh
+pip install transit-python             # JSON and JSON-verbose
+pip install 'transit-python[msgpack]'  # also msgpack, when running as pure Python
+```
+
+transit-python releases up to 0.8.302 support Python 2.7 and 3.5; later
+releases, from this repository, support Python 3.10 and later.
+
+The package includes a native extension, built from
+[transit-c](https://github.com/vendekagon-labs/transit-c), that reads and
+writes transit 4-15 times faster than pure Python, with identical results.
+PyPI has wheels with it compiled for Linux, macOS and Windows (x86_64 and
+ARM); elsewhere pip builds it from the source distribution if there's a C
+compiler, and otherwise installs the package as pure Python. Set
+`TRANSIT_PUREPYTHON=1` to use pure Python regardless (or, when installing
+from source, to not build the extension).
+
+The native extension reads and writes msgpack itself. Pure Python needs the
+[msgpack](https://pypi.org/project/msgpack/) package for that, installed
+with the `msgpack` extra; without it, creating a msgpack `Reader` or `Writer`
+raises an `ImportError` saying so.
+
+To install from GitHub:
+
+```sh
+pip install "transit-python[msgpack] @ git+https://github.com/vendekagon-labs/transit-python.git"
+```
+
+(add `@<tag or commit>` to the URL to pin a version, or use
+`git+ssh://git@github.com/...` to install over SSH). In a `pyproject.toml` or
+`requirements.txt`, use the same `transit-python @ git+https://...` form.
+
+## Usage
+
+```python
+# io can be any Python file descriptor,
+# like you would typically use with JSON's load/dump
+
+from transit.writer import Writer
+from transit.reader import Reader
+
+writer = Writer(io, "json") # or "json-verbose", "msgpack"
+writer.write(value)
+
+reader = Reader("json") # or "msgpack"
+val = reader.read(io)
+```
+
+For example:
+
+```
+>>> from transit.writer import Writer
+>>> from transit.reader import Reader
+>>> from io import StringIO
+>>> io = StringIO()
+>>> writer = Writer(io, "json")
+>>> writer.write(["abc", 1234567890])
+>>> s = io.getvalue()
+>>> reader = Reader()
+>>> vals = reader.read(StringIO(s))
+```
+
+
+To read a sequence of values as they arrive (e.g. from a pipe or socket),
+use `readeach`, which yields each value as soon as it has been read and stops
+at the end of the stream. A `Writer` can likewise write any number of values.
+
+```python
+reader = Reader("json")
+for value in reader.readeach(sys.stdin.buffer):
+    writer.write(value)
+```
+
+
+## Supported Python versions
+
+ * 3.10 and later
+
+
+## Type Mapping
+
+### Typed arrays, lists, and chars
+
+The [transit spec](https://github.com/cognitect/transit-format)
+defines several semantic types that map to more general types in Python:
+
+* lists map to Python Tuples
+* typed arrays (ints, longs, doubles, floats, bools), chars and bytes are
+  read as TaggedValues (e.g. `TaggedValue("ints", (1, 2, 3))`), so they
+  are written back out unchanged
+
+Use a TaggedValue to write these out if it will benefit a consuming
+app e.g.:
+
+```python
+writer.write(TaggedValue("ints", [1,2,3]))
+```
+
+### Python's bool and int
+
+In Python, bools are subclasses of int (that is, `True` is actually `1`).
+
+```python
+>>> hash(1)
+1
+>>> hash(True)
+1
+>>> True == 1
+True
+```
+
+This becomes problematic when decoding a map that contains bool and
+int keys.  The bool keys may be overridden (ie: you'll only see the int key),
+and the value will be one of any possible bool/int keyed value.
+
+```python
+>>> {1: "Hello", True: "World"}
+{1: 'World'}
+```
+
+To counter this problem, the latest version of Transit Python introduces a
+Boolean type with singleton (by convention of use) instances of "true" and
+"false." A Boolean can be converted to a native Python bool with bool(x) where
+x is the "true" or "false" instance. Logical evaluation works correctly with
+Booleans (that is, they override the __bool__ method and correctly evaluate
+as true and false in simple logical evaluation), but uses of a Boolean as an
+integer will fail.
+
+### Default type mapping
+
+|Transit type|Write accepts|Read returns|
+|------------|-------------|------------|
+|null|None|None|
+|string|str|str|
+|boolean|bool, transit\_types.Boolean|transit\_types.true, transit\_types.false|
+|integer|int|int|
+|decimal|float|float|
+|keyword|transit\_types.Keyword|transit\_types.Keyword|
+|symbol|transit\_types.Symbol|transit\_types.Symbol|
+|big decimal|decimal.Decimal|decimal.Decimal|
+|big integer|int|int|
+|time|datetime (timezone aware)|datetime (UTC)|
+|uri|transit\_types.URI|transit\_types.URI|
+|uuid|uuid.UUID|uuid.UUID|
+|char|transit\_types.TaggedValue|transit\_types.TaggedValue|
+|array|list, tuple|tuple|
+|list|transit\_types.TaggedValue|tuple|
+|set|set, frozenset|frozenset|
+|map|dict, transit\_types.frozendict|transit\_types.frozendict|
+|bytes|transit\_types.TaggedValue|transit\_types.TaggedValue|
+|shorts, ints, longs, floats, doubles, chars, bools|transit\_types.TaggedValue|transit\_types.TaggedValue|
+|link|transit\_types.Link|transit\_types.Link|
+
+
+## Development
+
+### Setup
+
+The tests read the exemplar files from
+[transit-format](http://github.com/cognitect/transit-format), which is
+expected to be checked out next to transit-python (or inside it, or set
+`TRANSIT_FORMAT_DIR` to its location).
+
+```sh
+pip install -e '.[test]'
+```
+
+The `test` extra includes msgpack. The msgpack tests are skipped when it
+isn't installed, so run the tests both with and without it.
+
+### Running the tests
+
+```sh
+pytest
+```
+
+### Running the transit-format verify harness
+
+transit-format's `bin/verify` drives `bin/roundtrip`, which runs with the
+`python3` on your `PATH`, so activate an environment with transit-python's
+dependencies installed first.
+
+```sh
+cd ../transit-format
+bin/verify -impls python
+```
+
+### Benchmarks
+
+```sh
+python -m tests.seattle_benchmark
+```
+
+### The native extension
+
+`transit/_native.c` wraps transit-c, whose sources are in `csrc/`, copied
+from [transit-c](https://github.com/vendekagon-labs/transit-c) by
+`bin/sync-transit-c` (which records the commit in `csrc/transit_c_version.h`);
+change them there, not here. `pip install -e .` builds the extension in place.
+The tests check that native and pure Python read and write identically;
+run them both ways (`TRANSIT_PUREPYTHON=1 pytest` for pure Python).
+
+`bin/verify` runs transit-format's verify harness in each encoding, with the
+[clojure CLI](https://clojure.org/guides/install_clojure), and fails if any
+roundtrip does.
+
+### Releasing
+
+The version is 0.8.<number of commits>. To release:
+
+```sh
+bin/make-release    # stamps the version into transit/__init__.py
+git commit -am "Release 0.8.N"
+git tag v0.8.N
+git push origin main v0.8.N
+```
+
+Pushing the tag runs `.github/workflows/wheels.yml`, which tests, builds the
+sdist and wheels (with [cibuildwheel](https://cibuildwheel.pypa.io)), and
+publishes them to PyPI with trusted publishing.
+
+
+## Contributing
+
+transit-python is maintained by [Vendekagon Labs](https://github.com/vendekagon-labs).
+Report problems and suggest changes with GitHub
+[issues](https://github.com/vendekagon-labs/transit-python/issues).
+
+Pull requests are welcome, but make sure they're well tested first: add tests
+for what you change, and check that the tests and transit-format's verify
+harness (`bin/verify`) pass, with both the native extension and pure Python
+(`TRANSIT_PUREPYTHON=1`).
+
+## Copyright and License
+
+Copyright © 2026 Vendekagon Labs LLC
+
+Copyright © 2014-2016 Cognitect
+
+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.