{"id":921,"date":"2021-07-01T12:02:41","date_gmt":"2021-07-01T16:02:41","guid":{"rendered":"https:\/\/www.alpharithms.com\/?p=921"},"modified":"2022-06-16T15:23:54","modified_gmt":"2022-06-16T19:23:54","slug":"python-breakpoint-built-in-function","status":"publish","type":"post","link":"https:\/\/www.alpharithms.com\/python-breakpoint-built-in-function-410212\/","title":{"rendered":"Python breakpoint(): Debugging With Ease"},"content":{"rendered":"

The Python breakpoint() built-in function is a tool that allows developers to set points in code at which a debugger is called. By default, this function results in an instantiation of Python’s native debugger class. Since 3.7 however, developers can easily override this behavior and use the Python breakpoint() function to execute custom actions.<\/p>\n

Debugging is an essential aspect of writing good code. This is true whether one is attempting to get initial logic operating, testing edge cases, or working to understand inherited<\/em> code.<\/p>\n

Python’s breakpoint()<\/code> function can be used for all of the above. In this article, you’ll learn the basic syntax of using breakpoint()<\/code>, the related call stack, an interesting environmental variable, and basic implementation guidelines. I’ll show how you can define a custom function to handle breakpoints also but won’t dive into too much technical detail.<\/p>\n

TL;DR<\/strong> – The Python breakpoint()<\/code> function calls Python’s debugger at a given line.<\/p>\n

# Create a loop over 5 integers\r\nfor i in range(5):\r\n\r\n    # Stream i to stdout\r\n    print(i)\r\n\r\n    # Create breakpoint at # 3\r\n    if i == 3:\r\n        breakpoint()\r\n\r\n# Output\r\n0\r\n1\r\n2\r\n3\r\n> c:\\users\\user\\path\\to\\your\\project\\example.py(24)<module>()\r\n-> for i in range(5):\r\n(Pdb) \r\n<\/pre>\n
Quick History<\/h2>\n
Python’s breakpoint()<\/code> built-in function was a new addition in version 3.7<\/a> via PEP553<\/a>. The rationale behind adding the breakpoint()<\/code> function touched on multiple points to better utilize the native pdp<\/code> debugger and afford developers more flexible options. The main points of rationale were as follows:<\/p>\n
    \n
  1. The previous syntax was clunky and overly verbose: import pdb; pdb.set_trace()<\/code>;<\/li>\n
  2. Limits debugging options to the pdp<\/code>;<\/li>\n
  3. Linters hate multiple statements in single lines.<\/li>\n<\/ol>\n
    PEP553 based its proposal for the new breakpoint()<\/code> function on JavaScript’s js-debugger. Also of note, this PEP outlined new bindings to the sys module to provide added flexibility for breakpoint()<\/code>.<\/p>\n
    The most pertinent being the sys.breakpointhook()<\/code> method. Additionally, PEP553 outlined the addition of a new environment variable named PYTHONBREAKPOINT<\/code> to define custom debuggers, disable debugging, or resort to default behavior (pdp<\/code>.) This article will only touch on these functions and variables minimally to illustrate the most basic<\/em> use of the breakpoint()<\/code> function.<\/p>\n
    Debugging 101: Using the Print Statement<\/h2>\n
    Breakpoints are used to help developers identify and address problems in their code. These can be syntax errors, logical errors, runtime errors, compile-time errors, or anything in between. Breakpoints are integral to the process of debugging.<\/p>\n
    Python’s breakpoint()<\/code> function provides a dynamic, easily customizable, and syntactically simple approach to debugging that uses the default pdp interactive debugger by default. Consider the following function:<\/p>\n
    def find_min(nums: [int]) -> int:\r\n    \"\"\"Finds the smallest integer value in a list\"\"\"\r\n    smallest = 0\r\n    for num in nums:\r\n        if num < smallest:\r\n            smallest = num\r\n    return smallest<\/pre>\n
    This function is designed to take a list of integers as an argument and return the smallest value. Given an argument of [9, 6, 3]<\/code> the\u00a0intended<\/em> (maybe not expected<\/em> if you’ve spotted the error already) behavior is to return 3. Let’s see what happens:<\/p>\n
    # Call the function to find the min\r\n# value in a list of integers\r\n>>> find_min([9, 6, 3])\r\n\r\n0<\/pre>\n
    Yikes. My function returned a value of 0 which was not intended (but expected!) Let’s pretend that the source of this bug isn’t clear\u2014meaning we need to\u00a0debug<\/em> the code! Debugging often is done with little more than added print statements to stream a simple message to a system’s standard output (stdout.) In this case, we could do the following to try and narrow down the source of the issue:<\/p>\n
    def find_min(nums: [int]) -> int:\r\n    \"\"\"Finds the smallest integer value in a list\"\"\"\r\n    smallest = 0\r\n    for num in nums:\r\n        \r\n        print('num:', num, 'smallest:', smallest)\r\n        if num < smallest:\r\n            \r\n            print('num smaller; re-assigning value:', num)\r\n            smallest = num\r\n            \r\n    return smallest<\/pre>\n
    We’ve now added two statements in our code that will print a message during each iteration of our loop that checks the smallest vs. num and upon num < smallest resulting True. Let’s see our output:<\/p>\n
    # Call the function with the \r\n# same args as before\r\n>>> find_min([9, 6, 3])\r\n\r\nnum: 9 smallest: 0\r\nnum: 6 smallest: 0\r\nnum: 3 smallest: 0\r\n0<\/pre>\n
    Note we now have three additional lines of output that detail the values of our variables. Also, note that the print<\/code> statement in our if num < smallest:<\/code> conditional is never displayed. This is our first hint at the nature of our code’s error. We can tell from this omission that no number in our list is\u00a0ever<\/em> being considered the lowest.<\/p>\n
    This is because our initial value for smallest is assigned a value of 0 which, in this case, is lower than any argument passed to our function! This test case results in undesired behavior and reflects a bug in our code. A fix would be to initialize the smallest variable with an infinitely large value like smallest = float('inf')<\/code>. Let’s see that fix in action:<\/p>\n
    # Update the instantiation of smallest\r\ndef find_min(nums[int]) -> int:\r\n    ...\r\n    smallest = float('inf')\r\n    ...\r\n\r\n# Re-run the code\r\n>>> find_min([9, 6, 3])\r\n\r\n# Output \r\nnum: 9 smallest: inf\r\nnum smaller; re-assigning value: 9\r\nnum: 6 smallest: 9\r\nnum smaller; re-assigning value: 6\r\nnum: 3 smallest: 6\r\nnum smaller; re-assigning value: 3\r\n3<\/pre>\n
    As you can see here, each iteration in the resulting loop finds a smaller value. The sequence of events is now as such:<\/p>\n
      \n
    1. 9 is smaller than infinity; replace the value of smallest;<\/li>\n
    2. 6 is smaller than 9; replace the value of smallest;<\/li>\n
    3. 3 is smaller than 6; replace the value of smallest;<\/li>\n
    4. return smallest<\/li>\n<\/ol>\n
      This flow is reflected by the output to console via the print<\/code> statements [still] embedded in our code. We’ve managed to find the issue, implement a solution, and confirmed our expected behavioral outcome.<\/p>\n
      However, we are now left with several print<\/code> statements that should be removed from our code. In this case, two lines are no big deal\u2014but imagine debugging a codebase with millions<\/em> of lines of code spread across many loosely coupled modules, classes, and functions. Debugging via print<\/code> statements could get troublesome quickly. Enter the interactive debugger<\/strong>.<\/p>\n
      Interactive Debuggers<\/h2>\n
      Interactive debuggers allow developers to pause their code in real-time, “step into” specific lines, view variables in run-time dynamics, and provide a myriad of other features\u2014none of which rely on print statements or additional code.<\/p>\n
      The Python Debugger provides developers with this utility out-of-the-box. Many elect to use the debugger provided by modern Integrated Development Environments (IDE) like PyCharm, Visual Studio, or **shudders<\/em>** Eclipse. This out-of-the-box functionality is one reason Python has become such a popular programming language<\/a> among such a wide range of developers.<\/p>\n
      Python’s pdp<\/code> debugger has been available to developers for some time. Since 3.7 however, it can be more easily accessed via the breakpoint()<\/code> function. This allows a simple call to a function to launch an interactive debugging session!<\/p>\n
      Let’s re-consider the bug we found in our code from above. This time, let’s use the breakpoint()<\/code> function rather than print statements to deduce the problem!<\/p>\n
      def find_min(nums: [int]) -> int:\r\n    \"\"\"Finds the smallest integer value in a list\"\"\"\r\n\r\n    # Instantiate initial smallest value\r\n    smallest = 0\r\n\r\n    # consider each number in arguments\r\n    for num in nums:\r\n\r\n        # compare to current smallest value\r\n        breakpoint() # enter debug mode\r\n        if num < smallest:\r\n\r\n            # assign to smallest if value less\r\n            smallest = num\r\n    \r\n    # return final value for smallest\r\n    return smallest<\/pre>\n
      Here I’ve added a call to the breakpoint()<\/code> function just after we enter our loop that will consider each of the variables from our argument. This instructs Python to launch the default pdp debugger (more on how to control that decision later.) Re-launching our code results in the following output:<\/p>\n
      > c:\\users\\user\\path\\to\\your\\project\\example.py(<line_number>)find_min()\r\n -> for num in nums:\r\n (Pdb)<\/pre>\n
      This results in three lines of code: the first being a trace to the last stack frame caller, the second being the last next line in our code after the breakpoint()<\/code> was called, and the third is a prompt indicating we are now in an interactive session with the pdp debugger.<\/p>\n
      This is regarded as a command-prompt context in which developers can enter valid pdp commands<\/a> to gain insight into their code. I’m won’t go into depth on pdp commands here and will only use the n command to ‘step into’ the next line and the num and smallest commands to display the current values of those variables. Let’s see the results of launching breakpoint()<\/code> in action:<\/p>\n
      \"python
      Created using RePlit<\/a><\/figcaption><\/figure>\n
      As you can [hopefully] see in this series of actions, the breakpoint()<\/code> function launches an instance of the pdp<\/code> interactive debugger that prompts for commands. Using the n command instructs the pdp<\/code> to execute the next line of code.<\/p>\n
      By typing num<\/code> and smallest<\/code> I am able to view the current values of those variables. Through a series of n<\/code>, num<\/code>, and smallest<\/code> commands we can see that the value of smallest isn’t changing and that initializing it with a value of 0<\/code> was a logical error.<\/p>\n
      One obvious advantage is this approach allowed us to debug the function with much less added code\u2014a single breakpoint()<\/code> statement vs. multiple print<\/code> statements. With customization, we can even handle breakpoint()<\/code> behavior to sidestep having to remove that code later (removal still advisable though.)<\/p>\n
      Advanced Usage<\/h2>\n
      Python’s breakpoint()<\/code> function can be used without arguments as a standalone call that results in the behavior we’ve seen so far. Namely, a no-fuss instantiation of Python’s native interactive debugger. Breakpoint requires no arguments but will pass any arguments to Python’s sys.breakpointhook()<\/code> for interpretation.<\/p>\n
      This is great for out-of-the-box behavior, but not great for developers that prefer other debuggers. For example, one might want to integrate with a remote debugger like PyCharm or Web-PDP<\/a>. See this StackOverflow post<\/a> for considerations there. I won’t be going into that much depth here.<\/p>\n
      To demonstrate simpler customization with breakpoint()<\/code> we’ll create a custom function to replace the call to the pdp<\/code> debugger. There are three moving parts to this puzzle to be aware of before we get started:<\/p>\n
        \n
      1. sys.breakpointhook()<\/a><\/li>\n
      2. pdp.set_trace()<\/a><\/li>\n
      3. PYTHONBREAKPOINT<\/a><\/li>\n<\/ol>\n
        The\u00a0 breakpoint()<\/code> function calls sys.breakpointhook()<\/code> and which is just a wrapper for pdp.set_trace()<\/code> which then consults the PYTHONBREAKPOINT<\/code> environment variable. This variable dictates the type of action to be taken with respect to debugger choice (or custom function to be called.) If PYTHONBREAKPOINT<\/code> is not specified, the pdp<\/code> debugger will launch by default. Let’s consider this interplay visually:<\/p>\n
        \"python
        Python’s breakpoint() function starts a multi-stage action chain defining how debugging behavior is handled.<\/figcaption><\/figure>\n
        To illustrate a basic example of customized breakpoint()<\/code> behavior, I’m going to create a custom function that simply prints some information to the console. This will be a step backward in functionality from what the pdp<\/code> debugger offered but a step forwards in functionality from our original approach of using print statements. It’ll be a nice little compromise.<\/p>\n
        import os\r\n\r\n# Customize env variable value\r\nos.environ['PYTHONBREAKPOINT'] = 'examples.breakpoint.bp_handler'\r\n\r\n\r\ndef bp_handler(message: str) -> None:\r\n    \"\"\"A custom handler for breakpoint()\"\"\"\r\n    print(message)\r\n\r\n\r\ndef find_min(nums: [int]) -> int:\r\n    \"\"\"Finds the smallest integer value in a list\"\"\"\r\n    smallest = 0\r\n    for num in nums:\r\n        breakpoint(f'Num: {num} Smallest: {smallest}')\r\n        if num < smallest:\r\n            smallest = num\r\n    return smallest\r\n\r\n\r\nif __name__ == '__main__':\r\n    find_min([9, 6, 3])<\/pre>\n
        In the above code, I have told pdp.set_trace()<\/code> to use the bp_handler function via setting the value of the PYTHONBREAKPOINT<\/code> environment variable. In the find_min function, I’ve passed a string message to the breakpoint()<\/code> function, which is passed to the sys.breakpointhook()<\/code> call, which is passed to the pdp.set_trace()<\/code> which, ultimately Is passed to the bp_handler()<\/code> function and gets streamed to stdout. This is all wrapped up in the if __name__ == '__main__':<\/code> syntax and results in the following output:<\/p>\n
        Num: 9 Smallest: 0\r\nNum: 6 Smallest: 0\r\nNum: 3 Smallest: 0<\/pre>\n
        This prints out a message detailing the current state of our program via a description of the num<\/code> and smallest<\/code> values. Note that virtually any<\/em> functionality can be implemented in this manner. As an added bonus; all one needs to do to stop the debugging info from appearing on the console is to set the value of PYTHONBREAKPOINT<\/code> to ‘0’.<\/p>\n
        This causes the sys.breakpointhook()<\/code> function (upon being called by breakpoint()) to return immediately. This removes the immediate need to remove any breakpoint() statements from our code! Control and Convenience\u2014I love it.<\/p>\n
        Note<\/strong>: The value of PYTHONBREAKPOINT<\/code> must be a string. i.e. “0” (the char) not<\/em> 0 (the int literal.)<\/p>\n
        Final Thoughts<\/h2>\n
        Python’s breakpoint() function has afforded developers a much more robust standard debugging pipeline than previous releases. While the Python debugger is nothing new, the breakpoint()<\/code> builtin, along with the PYTHONBREAKPOINT<\/code> and sys.breakpointhook()<\/code> additions provide better control and convenience.<\/p>\n
        The examples in this article are of the most basic form. Advanced usage and integration with complex workflows and pipelines are certainly possible. Personally, I don’t find myself using breakpoint()<\/code> it very often and prefer to use a combination of PyCharm’s interactive debugger and the Python logging module. Between the two of these, I find I can usually rundown any bugs.<\/p>\n","protected":false},"excerpt":{"rendered":"
        The Python breakpoint() built-in function is a tool that allows developers to set points in code at which a debugger is called. By default, this function results in an instantiation of Python’s native debugger class. Since 3.7 however, developers can easily override this behavior and use the Python breakpoint() function to execute custom actions. Debugging […]<\/p>\n","protected":false},"author":2,"featured_media":925,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[655,10],"tags":[222,378,143],"acf":[],"_links":{"self":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts\/921"}],"collection":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/comments?post=921"}],"version-history":[{"count":4,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts\/921\/revisions"}],"predecessor-version":[{"id":928,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts\/921\/revisions\/928"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/media\/925"}],"wp:attachment":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/media?parent=921"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/categories?post=921"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/tags?post=921"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}