Method __init__

IPython/core/debugger.py:240–335

Create a new IPython debugger. Parameters ---------- completekey : default None Passed to pdb.Pdb. stdin : default None Passed to pdb.Pdb. stdout : default None Passed to pdb.Pdb. context : int Number of

(
        self,
        completekey=None,
        stdin=None,
        stdout=None,
        context: int | None | str = 5,
        *,
        mode: str | None = None,
        **kwargs,
    )

    }

    def __init__(
        self,
        completekey=None,
        stdin=None,
        stdout=None,
        context: int | None | str = 5,
        *,
        mode: str | None = None,
        **kwargs,
    ):
        """Create a new IPython debugger.

        Parameters
        ----------
        completekey : default None
            Passed to pdb.Pdb.
        stdin : default None
            Passed to pdb.Pdb.
        stdout : default None
            Passed to pdb.Pdb.
        context : int
            Number of lines of source code context to show when
            displaying stacktrace information.
        mode : str, optional
            How the debugger was invoked, one of ``'inline'`` (used by the
            ``breakpoint()`` builtin), ``'cli'`` (used by the command line
            invocation) or ``None`` (backwards compatible behaviour). This
            argument was added to stdlib's ``pdb.Pdb`` in Python 3.14; it is
            accepted on every supported Python version here but only forwarded
            to the underlying ``pdb.Pdb`` when it is actually supported.
        **kwargs
            Passed to pdb.Pdb.

        Notes
        -----
        The possibilities are python version dependent, see the python
        docs for more info.
        """
        # ipdb issue, see https://github.com/ipython/ipython/issues/14811
        if context is None:
            context = 5
        if isinstance(context, str):
            context = int(context)
        self.context = context

        # The `mode` argument was added to `pdb.Pdb` in Python 3.14. We accept
        # it on every supported Python version so that callers written against
        # 3.14+ keep working, but only forward it to the underlying `pdb.Pdb`
        # when it understands it.
        if sys.version_info >= (3, 14):
            kwargs["mode"] = mode
        else:
            self.mode = mode

        # `kwargs` ensures full compatibility with stdlib's `pdb.Pdb`.
        OldPdb.__init__(self, completekey, stdin, stdout, **kwargs)
        # Python 3.15+ should define this, so no need to initialize
        # this avoids some getattr(self, 'curframe')