Skip to content

GH-50027: [Format][C++][Python] Add fixed and variable closedness range canonical extension types - #50028

Open
Hoeze wants to merge 13 commits into
apache:mainfrom
Hoeze:feat/arrow-range-extension
Open

GH-50027: [Format][C++][Python] Add fixed and variable closedness range canonical extension types#50028
Hoeze wants to merge 13 commits into
apache:mainfrom
Hoeze:feat/arrow-range-extension

Conversation

@Hoeze

@Hoeze Hoeze commented May 24, 2026

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #50027 has been automatically assigned in GitHub to PR creator.

@rok

rok commented May 24, 2026

Copy link
Copy Markdown
Member

See comment.

Copilot AI lite review requested due to automatic review settings June 4, 2026 19:52

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review is ineligible. To be eligible to request a review, you need a paid Copilot license, or your organization must enable Copilot code review.

Comment thread cpp/src/arrow/extension/range.cc Outdated
}

// ---------------------------------------------------------------------------
// RangeIncType

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps wwe can find a better name than RangeInc?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Absolutely 😄
Some ideas:

  • VarRangeType
  • VariableClosedRangeType
  • PerValueRangeType

What do you think?

@Hoeze Hoeze Jun 4, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more idea:
FixedClosednessRangeType and VariableClosednessRangeType (similar to the tensor type naming

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Range and GranularRange? Naming is hard.

@github-actions github-actions Bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Jun 8, 2026
Add a canonical extension type for bounded ranges (mathematical intervals),
distinct from Arrow's calendar Interval (duration) type.

- Spec: docs/source/format/CanonicalExtensions.rst adds the Range section.
  Storage is Struct<lower, upper> with both bounds nullable (null = +/-infinity,
  treated as exclusive). A closed parameter (left/right/both/neither, pandas
  vocabulary) is carried as JSON extension metadata; the subtype is read from
  storage. Disambiguates from the calendar Interval type per DB convention
  (INTERVAL = duration, RANGE/PERIOD = bounded set).
- C++ reference impl: cpp/src/arrow/extension/range.{h,cc} (RangeType/RangeArray)
  with serialize/deserialize, storage validation, registration in the global
  registry, tests, and CMake/meson wiring.
The closedness is no longer defaulted on the wire: empty metadata or a JSON
object without a "closed" key is now rejected by Deserialize, so a serialized
arrow.range is always unambiguous. The C++ convenience default argument for
constructing a RangeType in code is left-closed ([lower, upper)), matching the
PostgreSQL/Rust/Python range convention. Spec and tests updated.
Verified by building the arrow-canonical-extensions-test target (50/50 pass,
10/10 RangeType). Two fixes to the previously-uncompiled test:
- include arrow/array/array_nested.h for the full StructArray definition
  (it is only forward-declared in type_fwd.h).
- wrap the CheckDeserialize helper in an anonymous namespace to avoid a
  link-time collision with the identically named helper in opaque_test.cc.
Add a sibling canonical extension type to arrow.range that stores bound
inclusivity per value via non-nullable boolean lower_inc/upper_inc fields,
storage Struct<lower:T, upper:T, lower_inc:bool, upper_inc:bool>.

arrow.range carries a single type-level closed parameter, sufficient for
discrete ranges that canonicalize to one closedness (int4range, int8range,
daterange). Continuous ranges (numrange, tsrange, tstzrange) cannot be
canonicalized, so closedness must travel with each value. arrow.range_inc
mirrors PostgreSQL's internal range representation for that case; both types
coexist.

The type has no metadata parameters: inclusivity lives in storage, so
Serialize emits {} and Deserialize accepts empty/{}/extra keys. A null
(infinite) bound is always exclusive regardless of its flag.

Covers C++ (type, array, registration, tests), pyarrow bindings and tests,
and the format spec, status table, and C++/Python API docs.
Under CMAKE_UNITY_BUILD (Windows CI), range_test.cc and opaque_test.cc are
merged into one translation unit. Both declared a CheckDeserialize helper
(range's in an anonymous namespace, opaque's in namespace arrow), making the
unqualified call ambiguous and failing the MSVC build with C2668. Rename the
range helper to CheckRangeDeserialize to remove the collision.
Use JsonWriter for Serialize and the simdjson DOM helpers for
Deserialize, matching the other canonical extension types.
Name the pair after arrow.fixed_shape_tensor and
arrow.variable_shape_tensor: closedness is either one type parameter
or stored per value.

- arrow.range -> arrow.fixed_closedness_range
- arrow.range_inc -> arrow.variable_closedness_range
- C++: RangeType/RangeArray -> FixedClosednessRangeType/Array,
  RangeIncType/RangeIncArray -> VariableClosednessRangeType/Array,
  range()/range_inc() -> fixed_closedness_range()/variable_closedness_range()
- pyarrow: range_/range_inc and the Range* classes follow the same names
@hoeze-minion
hoeze-minion force-pushed the feat/arrow-range-extension branch from f3ec0b6 to c414320 Compare September 13, 2026 00:24
Copilot AI review requested due to automatic review settings September 13, 2026 00:24

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review is ineligible. To be eligible to request a review, you need a paid Copilot license, or your organization must enable Copilot code review.

@github-actions github-actions Bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Sep 13, 2026
@Hoeze Hoeze changed the title GH-50027: [Format][C++][Python] Add arrow.range canonical extension type GH-50027: [Format][C++][Python] Add fixed and variable closedness range canonical extension types Sep 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants