ezmsg.sigproc.util.deprecation#

Deprecation of the per-processor axis setting.

The mechanism lives in ezmsg.baseproc.util.deprecation; what belongs here is the policy – which release drops these settings, and the fact that it is this distribution making the promise.

A processor that carries state between messages – filter initial conditions, a running mean, a sample buffer, a previous-sample cache – can only do so along the dimension messages accumulate along. Carrying it along a static axis is not a smaller error but a different operation: that axis has the same length every message, so the carried state applies message N’s tail to message N+1’s head at the same coordinate, forever.

Which dimension that is belongs to the producer, and stream_dim is where it says so. A setting that lets a consumer disagree can only be used to be wrong, so it is going away; see resolve_stream_dim().

During the deprecation window the setting is still honoured, so nothing changes behaviour until it is removed. Two warnings partition the call sites:

  • This module’s construction-time FutureWarning fires for every use, including a harmless axis="time" on a raw stream. It means “delete this”.

  • resolve_configured_stream_dim()’s runtime warning fires only when the configured axis disagrees with a declared stream_dim. It means “deleting this will change what this stage computes”.

To find every remaining call site in a pipeline, run its tests with -W error::FutureWarning.

Module Attributes

AXIS_REMOVAL_VERSION

Release that drops the deprecated axis settings.

Functions

warn_axis_deprecated(settings, field='axis')[source]#

Warn that settings’ field is deprecated, if it was actually set.

Binds ezmsg.baseproc.warn_axis_deprecated() to this distribution and its removal release, so the call sites stay a single line and every message agrees about when the setting goes away. Not a re-export: suppression and the resolution rules come from ezmsg.baseproc directly, so there is exactly one of each in play.

Parameters:
Return type:

None