Skip to main content

crosswalk-codec

The Python package of crossmap, a bidirectional crosswalk codec. One crosswalk document describes how to map between a dataset's native JSON shape and a shared target shape, and that one document derives both directions: decode undoes encode over the paths the crosswalk maps, and what cannot be undone is declared as one-way rules. The codec is the Rust crate, built into one wheel per platform against CPython's stable ABI, so a wheel installs on CPython 3.11 and every later version. The crosswalk format is documented in the crossmap README.

pip install crosswalk-codec
from crosswalk_codec import assert_round_trip, decode, encode, parse_crosswalk

crosswalk = parse_crosswalk(
    {
        "source": "field-sensors/reading",
        "target": "observations/v1",
        "rules": [
            {"op": "move", "from": "rows[].sensor", "to": "observations[].deviceId"},
            {"op": "scale", "from": "rows[].depthM", "to": "observations[].depthMm", "factor": 1000},
        ],
        "oneWay": [{"op": "drop", "from": "rows[].batteryPct", "direction": "encode"}],
    }
)

table = {"rows": [{"sensor": "S-01", "depthM": 3, "batteryPct": 91}]}
encode(crosswalk, table)
# {'observations': [{'deviceId': 'S-01', 'depthMm': 3000}]}

decode(crosswalk, encode(crosswalk, table))
# {'rows': [{'sensor': 'S-01', 'depthM': 3}]}: batteryPct was declared lossy

assert_round_trip(crosswalk, [table])

API

The names follow the npm package's and the Rust crate's in Python's spelling.

Name
parse_crosswalk(document) Parses a crosswalk document into an immutable Crosswalk (source, target, schema, to_dict() for the parsed form). Raises CrosswalkSyntaxError carrying every issue.
validate_crosswalk(crosswalk) The structural defects of the rule list as CrosswalkIssues, empty when it can execute.
encode(crosswalk, document), decode(crosswalk, document) Translate a document in either direction. A crosswalk is validated and prepared the first time it is used and kept prepared, so translating many documents with one Crosswalk validates it once.
compile_crosswalk(crosswalk) Validates and prepares now, raising CrosswalkStructureError here, and returns a CompiledCrosswalk with encode(document) and decode(document).
assert_round_trip(crosswalk, samples) Encodes and decodes each sample and raises RoundTripMismatchError at the first difference, leaving out the paths one-way rules touch.
rule_sides(rule) The from_ and to paths of a two-way rule, such as an element of crosswalk.to_dict()["rules"].
json_schema_text() The crosswalk format's JSON Schema 2020-12 document as text, byte for byte the crossmap/schemas/crossmap.schema.json the npm package of the same version ships.

Every error the codec raises is a CrossmapError: CrosswalkSyntaxError and CrosswalkStructureError carry issues (SyntaxIssue(message), CrosswalkIssue(rule_index, message)), RuleApplicationError carries rule_index, path and detail, and RoundTripMismatchError carries sample_index, path and detail. A when predicate that cannot be evaluated at all (a lookup node, or a collection that is not an array of records) raises ValueError, as the npm package throws a plain Error there.

The package installs the crossmap command, the same command the npm package installs, documented in the crossmap README.

Documents and numbers

Documents are native Python values: dict with str keys, list, str, int, float, bool and None, and their subclasses. Anything else raises TypeError, naming where it is in the document: a tuple, a set or bytes is refused rather than turned into something else, since decode could not give it back. A document is converted once on the way in and once on the way out, straight to and from the codec's own value, never through JSON text, and the interpreter is released while the codec runs.

A JSON number is an IEEE double, as JavaScript's JSON.parse reads it, so numbers convert by their value as a double:

  • An int is accepted when a double has exactly its value: every integer of magnitude up to 2^53, and larger ones a double holds exactly. Any other int raises ValueError rather than being rounded, where JSON.parse would round the same digits to the nearest double. A float is accepted when it is finite; NaN and the infinities raise ValueError, since JSON cannot write them.
  • A number comes back as an int when it is a safe integer (integral with magnitude at most 2^53 - 1, as Number.isSafeInteger defines it) and as a float otherwise. So 3, 3.0 and 3e0 all come back as 3, which is what json.loads gives for the text JSON.stringify writes for each of them, and 2.5 and 1e300 come back as float. Negative zero comes back as the float -0.0, keeping its sign.

Records keep their key order, in the order a JavaScript object would list the same keys: keys that are array indices ("0", "17") first in numeric order, then the others in insertion order. A document may nest 127 arrays and records, the root included, which is as deep as the crossmap command reads from JSON text; deeper nesting, or a container that contains itself, raises ValueError.

MIT licensed.

Metadata

Release files for crosswalk-codec 0.12.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crosswalk-codec 0.12.2
File Size Uploaded Provenance Actions
crosswalk_codec-0.12.2.tar.gz 122.7 kB With provenance Details for crosswalk_codec-0.12.2.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for crosswalk-codec 0.12.2
File Actions
crosswalk_codec-0.12.2-cp311-abi3-win_arm64.whl CPython 3.11 abi3 Windows ARM64 Details for crosswalk_codec-0.12.2-cp311-abi3-win_arm64.whl
crosswalk_codec-0.12.2-cp311-abi3-win_amd64.whl CPython 3.11 abi3 Windows x86-64 Details for crosswalk_codec-0.12.2-cp311-abi3-win_amd64.whl
crosswalk_codec-0.12.2-cp311-abi3-musllinux_1_2_x86_64.whl CPython 3.11 abi3 Linux musl 1.2+ x86-64 Details for crosswalk_codec-0.12.2-cp311-abi3-musllinux_1_2_x86_64.whl
crosswalk_codec-0.12.2-cp311-abi3-musllinux_1_2_aarch64.whl CPython 3.11 abi3 Linux musl 1.2+ ARM64 Details for crosswalk_codec-0.12.2-cp311-abi3-musllinux_1_2_aarch64.whl
crosswalk_codec-0.12.2-cp311-abi3-manylinux_2_28_x86_64.whl CPython 3.11 abi3 Linux glibc 2.28+ x86-64 Details for crosswalk_codec-0.12.2-cp311-abi3-manylinux_2_28_x86_64.whl
crosswalk_codec-0.12.2-cp311-abi3-manylinux_2_28_aarch64.whl CPython 3.11 abi3 Linux glibc 2.28+ ARM64 Details for crosswalk_codec-0.12.2-cp311-abi3-manylinux_2_28_aarch64.whl
crosswalk_codec-0.12.2-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details for crosswalk_codec-0.12.2-cp311-abi3-macosx_11_0_arm64.whl
crosswalk_codec-0.12.2-cp311-abi3-macosx_10_12_x86_64.whl CPython 3.11 abi3 macOS 10.12+ x86-64 Details for crosswalk_codec-0.12.2-cp311-abi3-macosx_10_12_x86_64.whl

Total release size: 15.4 MB

Release files / crosswalk_codec-0.12.2.tar.gz

Download URL crosswalk_codec-0.12.2.tar.gz
Size 122.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f702e4723ed49d60953937f2c8c8bea85e64df818b38f0559a011cd46bfb37bb
BLAKE2b-256 checksum
How to use checksums
6d87a6a2036bdc4b858b6d20ba9085923482d0304fb285e6f7052ad2c200e498
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / crosswalk_codec-0.12.2-cp311-abi3-win_arm64.whl

Download URL crosswalk_codec-0.12.2-cp311-abi3-win_arm64.whl
Size 1.6 MB
Tags CPython 3.11 Windows ARM64 abi3
SHA-256 checksum
How to use checksums
79ff676f2179e33519d5e1c4443aa9d3a8eaaf9139b948886c1886ede57956e8
BLAKE2b-256 checksum
How to use checksums
f288d724825606cf28ff37a22f874419ae208adfc353047a1626e86e1b997c70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / crosswalk_codec-0.12.2-cp311-abi3-win_amd64.whl

Download URL crosswalk_codec-0.12.2-cp311-abi3-win_amd64.whl
Size 1.7 MB
Tags CPython 3.11 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
76c1efe4a44b530510b61a51987bd18e2d401ba9c73b0434f08556fd1e9dbedb
BLAKE2b-256 checksum
How to use checksums
95fbe56e3be5df5345657cc664a54088bd2be494c2439f4390919af91a5fa715
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / crosswalk_codec-0.12.2-cp311-abi3-musllinux_1_2_x86_64.whl

Download URL crosswalk_codec-0.12.2-cp311-abi3-musllinux_1_2_x86_64.whl
Size 2.2 MB
Tags CPython 3.11 Linux musl 1.2+ x86-64 abi3
SHA-256 checksum
How to use checksums
606776f21fcd4b624fc02a45759857dbf2d085cc11b0dbfa64d9c0c421e4b30c
BLAKE2b-256 checksum
How to use checksums
c4f7ba5d8b85b6879aae511e12b5c8c33a08c117ca232a8df74d9aeffcc9c4c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / crosswalk_codec-0.12.2-cp311-abi3-musllinux_1_2_aarch64.whl

Download URL crosswalk_codec-0.12.2-cp311-abi3-musllinux_1_2_aarch64.whl
Size 2.2 MB
Tags CPython 3.11 Linux musl 1.2+ ARM64 abi3
SHA-256 checksum
How to use checksums
00488220fa96097623f656dee9a011e22a7c06ac2b1e568374c12e72f8ef4fd7
BLAKE2b-256 checksum
How to use checksums
08cfe844d59f32205f9d67373f8800a87c3eb8121a0f194c5760c987878db7dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / crosswalk_codec-0.12.2-cp311-abi3-manylinux_2_28_x86_64.whl

Download URL crosswalk_codec-0.12.2-cp311-abi3-manylinux_2_28_x86_64.whl
Size 2.0 MB
Tags CPython 3.11 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
397e8ebae51e7d045fc3ae2b13b69f27c24107912a7a533b2b751e8a820b9eb0
BLAKE2b-256 checksum
How to use checksums
9e026a40ca94042c0b279fa4b2b20228126a41778e47bebd8f4706bc6fd00255
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / crosswalk_codec-0.12.2-cp311-abi3-manylinux_2_28_aarch64.whl

Download URL crosswalk_codec-0.12.2-cp311-abi3-manylinux_2_28_aarch64.whl
Size 2.0 MB
Tags CPython 3.11 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
4c821ac8e81bc5ce6f5ce33fd86b6001737ca2daa16eed706d3fb4ca1b253147
BLAKE2b-256 checksum
How to use checksums
029fe4b0b6dd9eeb1c7bd6e320855c31ae3065aa0006231ee804d60301778202
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / crosswalk_codec-0.12.2-cp311-abi3-macosx_11_0_arm64.whl

Download URL crosswalk_codec-0.12.2-cp311-abi3-macosx_11_0_arm64.whl
Size 1.8 MB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
7de16c802c9aebbb494e41b458840875baecafbbb5f9200399838834bb79604e
BLAKE2b-256 checksum
How to use checksums
0b2eeb9e4471af17fb0a995a144785de8b46ad7d665f1f57775a313542da763e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / crosswalk_codec-0.12.2-cp311-abi3-macosx_10_12_x86_64.whl

Download URL crosswalk_codec-0.12.2-cp311-abi3-macosx_10_12_x86_64.whl
Size 1.8 MB
Tags CPython 3.11 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
20c81bc3b65e2285900a83750be02c9004d50608274536ad8edbdc6f2514c7d5
BLAKE2b-256 checksum
How to use checksums
d7478bb90d35fccd536ae297d0c515dc9e8fae1f520931ef56dfea3e9e9c0b43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Security for crosswalk-codec 0.12.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 9 files in this release have been uploaded with provenance metadata.

Select from 9 files

Attestation for crosswalk_codec-0.12.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page