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.3

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.3
File Size Uploaded Provenance Actions
crosswalk_codec-0.12.3.tar.gz 122.7 kB With provenance Details for crosswalk_codec-0.12.3.tar.gz

Built distributions (wheels)

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

Total release size: 15.4 MB

Release files / crosswalk_codec-0.12.3.tar.gz

Download URL crosswalk_codec-0.12.3.tar.gz
Size 122.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2dcb64b5080a09bfbc5c71107fdcbb25b17a1c56586b1bc034a3f6454526514c
BLAKE2b-256 checksum
How to use checksums
72230718eec9e6b1c06349892a5543df1d3dc2e7a45299973c64c4be5b278477
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.3-cp311-abi3-win_arm64.whl

Download URL crosswalk_codec-0.12.3-cp311-abi3-win_arm64.whl
Size 1.6 MB
Tags CPython 3.11 Windows ARM64 abi3
SHA-256 checksum
How to use checksums
dcd036c43362bbdc4265cb1501072df4eefff4af2cd0214ceed90f200817ed8e
BLAKE2b-256 checksum
How to use checksums
588be5b78be063cf0dc539f1ad8a7b77cd0df48eef6e74b07dfbb0ade1e86165
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.3-cp311-abi3-win_amd64.whl

Download URL crosswalk_codec-0.12.3-cp311-abi3-win_amd64.whl
Size 1.7 MB
Tags CPython 3.11 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
e48aaee508716dcecb55c4e1c920904b92ff091e5904222c12ef8e5f00f1a6c4
BLAKE2b-256 checksum
How to use checksums
b89c9a5c130d95bce57a9c611c56487d3ba2410c644c3c81662b92f134c17e9b
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.3-cp311-abi3-musllinux_1_2_x86_64.whl

Download URL crosswalk_codec-0.12.3-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
e5209e29679bd989ee4504da8b2e5902e630627787ca955281cc758a73a05261
BLAKE2b-256 checksum
How to use checksums
d18e65039821be0f2f47c5f399afc41a27fd643d9b26c49b03aa4ed0691af54a
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.3-cp311-abi3-musllinux_1_2_aarch64.whl

Download URL crosswalk_codec-0.12.3-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
09930e213a951545f9e6cdadc38a47fe92cbf7c857739289d75bb164c8d9acf6
BLAKE2b-256 checksum
How to use checksums
8778e1d81d9864f56e82261ed41425109485c09cf8f0a5f653418cd877d872fe
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.3-cp311-abi3-manylinux_2_28_x86_64.whl

Download URL crosswalk_codec-0.12.3-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
0e8c8234fb2e36ce99aed3ed19767827d94203026bf9f5b66373c523e5a6cf9d
BLAKE2b-256 checksum
How to use checksums
361c911af6bb0c7db1f609336a905d389affa46b2186c9d7d57de35871b00f22
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.3-cp311-abi3-manylinux_2_28_aarch64.whl

Download URL crosswalk_codec-0.12.3-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
7d8c76a3e27e0d9022fdefeca4dbde6237647e59fe07b03106a96bb36911367e
BLAKE2b-256 checksum
How to use checksums
9b269b9a0744291d07b6340957186d2e89c09a71ea1889266feecb85490c09e4
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.3-cp311-abi3-macosx_11_0_arm64.whl

Download URL crosswalk_codec-0.12.3-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
1445f9de3e10cdc5f4e5c583959d8c4013b1e09bcbfc7e5a107f4b37a991fe83
BLAKE2b-256 checksum
How to use checksums
673e7044adab6a34a45b77c7821b8c053c6cfd3cfaa6f1f4d8c25843cfcc35a6
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.3-cp311-abi3-macosx_10_12_x86_64.whl

Download URL crosswalk_codec-0.12.3-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
6d4e3468bbde2e912ae9dbf37066fecb3d2caf7ea4441458b91690a8adc3eb9e
BLAKE2b-256 checksum
How to use checksums
bbf0efac42f337e361bea5bd25e9d4c0f3c77d38ded6b7cd90a7fa12304b5829
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.3

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.3.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