# utils

## Module: `utils`

Inheritance diagram for `nipy.utils`:

General utilities for code support.

These are modules that we (broadly-speaking) wrote; packages that other people wrote, that we ship, go in the nipy.externals tree.

## `VisibleDeprecationWarning`

class nipy.utils.VisibleDeprecationWarning

  Bases: `UserWarning`

  Visible deprecation warning.

  Python does not show any DeprecationWarning by default. Sometimes we do want to show a deprecation warning, when the deprecation is urgent, or the usage is probably a bug.

  __init__(*args, **kwargs)
  add_note(note, /)

    Add a note to the exception

  args
  with_traceback(tb, /)

    Set self.__traceback__ to tb and return self.

nipy.utils.deprecate_with_doc(msg)