Skip to content

Document jaxtyping sentinel-pickle upstream fix and pixi override#7

Open
hmgaudecker wants to merge 1 commit into
mainfrom
doc/beartype-jaxtyping-upstream-sentinel-fix
Open

Document jaxtyping sentinel-pickle upstream fix and pixi override#7
hmgaudecker wants to merge 1 commit into
mainfrom
doc/beartype-jaxtyping-upstream-sentinel-fix

Conversation

@hmgaudecker
Copy link
Copy Markdown
Member

Summary

Update the beartype module guidance to describe the upstream jaxtyping fix and the temporary pixi override projects use until it ships.

Changes

Split the existing "jaxtyping ellipsis-sentinel pickle patch" section into two:

  1. Upstream sentinel-cloudpickle fix. All three module-level `object()` sentinels (`_any_dtype`, `_anonymous_dim`, `_anonymous_variadic_dim`) get `reduce`-backed singletons in patrick-kidger/jaxtyping#390, released as `jaxtyping >= 0.3.10`. Shows the floor pin + pixi pypi-dependency override (pointing at the fork's `fix/sentinel-cloudpickle` branch) that projects use until the release lands.
  2. `Ellipsis` ↔ `"..."` shim. Still needed on projects using `from future import annotations` (i.e. supporting Python < 3.14); points at `ttsim/_jaxtyping_patch.py` for the implementation. Notes that projects on 3.14-only floors that have dropped the future-import (pylcm is in that bucket) do not need it.

Test plan

  • Cross-reference renders correctly in the rendered module index.

The local `_jaxtyping_patch.py` workaround for the variadic-dim
sentinel is superseded by `jaxtyping >= 0.3.10`
(patrick-kidger/jaxtyping#390), which fixes all three module-level
sentinels at the source. Until the release ships, projects use a pixi
pypi-dependency override to pull the fork branch.

Split the existing "ellipsis-sentinel pickle patch" section into two:
the upstream-fixed sentinel issue (with the override snippet and
floor-pin guidance), and the surviving `Ellipsis` ↔ `"..."` shim,
which is needed only on projects still using `from __future__ import
annotations` (i.e. supporting Python < 3.14).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant