warn_deprecated

warn_deprecated(
  since: str,
  *,
  message: str = '',
  name: str

Parameters

Name	Type	Description
`since`*	`str`	The release at which this API became deprecated.
`message`	`str`	Default:`''` Override the default deprecation message. The `%(since)s`, `%(name)s`, `%(alternative)s`, `%(obj_type)s`, `%(addendum)s`, and `%(removal)s` format specifiers will be replaced by the values of the respective arguments passed to this function.
`name`	`str`	Default:`''` The name of the deprecated object.
`alternative`	`str`	Default:`''`
`alternative_import`	`str`	Default:`''`
`pending`	`bool`	Default:`False`
`obj_type`	`str`	Default:`''`
`addendum`	`str`	Default:`''`
`removal`	`str`	Default:`''`
`package`	`str`	Default:`''`

Display a standardized deprecation.

An alternative API that the user may use in place of the deprecated API.

The deprecation warning will tell the user about this alternative if provided.

An alternative import that the user may use instead.

If True, uses a PendingDeprecationWarning instead of a DeprecationWarning.

Cannot be used together with removal.

The object type being deprecated.

Additional text appended directly to the final message.

The expected removal version.

With the default (an empty string), a removal version is automatically computed from since. Set to other Falsy values to not schedule a removal date.

Cannot be used together with pending.

The package of the deprecated object.