kd.objs API

Operators that work solely with objects.

kd.objs.like(shape_and_mask_from: DataSlice, /, *, itemid: DataSlice | None = None, **attrs: Any) -> DataSlice

Aliases:

• kd.obj_like

Creates Objects with shape and sparsity from shape_and_mask_from.

Returned DataSlice has OBJECT schema and is immutable.

Args:
  shape_and_mask_from: DataSlice, whose shape and sparsity the returned
    DataSlice will have.
  itemid: optional ITEMID DataSlice used as ItemIds of the resulting obj(s).
  **attrs: attrs to set in the returned Entity.

Returns:
  data_slice.DataSlice with the given attrs.

kd.objs.new(arg: Any = unspecified, /, *, itemid: DataSlice | None = None, **attrs: Any) -> DataSlice

Aliases:

• kd.obj

Creates new Objects with an implicit stored schema.

Returned DataSlice has OBJECT schema and is immutable.

Args:
  arg: optional Python object to be converted to an Object.
  itemid: optional ITEMID DataSlice used as ItemIds of the resulting obj(s).
    itemid will only be set when the args is not a primitive or primitive
    slice if args presents.
  **attrs: attrs to set on the returned object.

Returns:
  data_slice.DataSlice with the given attrs and kd.OBJECT schema.

kd.objs.shaped(shape: JaggedShape, /, *, itemid: DataSlice | None = None, **attrs: Any) -> DataSlice

Aliases:

• kd.obj_shaped

Creates Objects with the given shape.

Returned DataSlice has OBJECT schema and is immutable.

Args:
  shape: JaggedShape that the returned DataSlice will have.
  itemid: optional ITEMID DataSlice used as ItemIds of the resulting obj(s).
  **attrs: attrs to set in the returned Entity.

Returns:
  data_slice.DataSlice with the given attrs.

kd.objs.shaped_as(shape_from: DataSlice, /, *, itemid: DataSlice | None = None, **attrs: Any) -> DataSlice

Aliases:

• kd.obj_shaped_as

Creates Objects with the shape of the given DataSlice.

Returned DataSlice has OBJECT schema and is immutable.

Args:
  shape_from: DataSlice, whose shape the returned DataSlice will have.
  itemid: optional ITEMID DataSlice used as ItemIds of the resulting obj(s).
  **attrs: attrs to set in the returned Entity.

Returns:
  data_slice.DataSlice with the given attrs.

kd.objs.uu(seed: str | None = None, **attrs: Any) -> DataSlice

Aliases:

• kd.uuobj

Creates object(s) whose ids are uuid(s) with the provided attributes.

Returned DataSlice has OBJECT schema and is immutable.

In order to create a different "Type" from the same arguments, use
`seed` key with the desired value, e.g.

kd.uuobj(seed='type_1', x=kd.slice([1, 2, 3]), y=kd.slice([4, 5, 6]))

and

kd.uuobj(seed='type_2', x=kd.slice([1, 2, 3]), y=kd.slice([4, 5, 6]))

have different ids.

Args:
  seed: (str) Allows different uuobj(s) to have different ids when created
    from the same inputs.
  **attrs: key-value pairs of object attributes where values are DataSlices
    or can be converted to DataSlices using kd.new / kd.obj.

Returns:
  data_slice.DataSlice