example.py

from sys import stderr

from crab_dbg import dbg


class Node:
    def __init__(self, val=0, next_=None, prev=None):
        self.val = val
        self.next = next_
        self.prev = prev


class DoubleLinkedList:
    def __init__(self, head=None, tail=None):
        self.head = head
        self.tail = tail

    @staticmethod
    def create(n: int) -> "DoubleLinkedList":
        """
        Create a LinkedList of n elements, value ranges from 0 to n - 1.
        """
        if n <= 0:
            raise ValueError("A double linked list with %d element is meaningless", n)

        head = Node(0)

        cur = head
        for i in range(1, n):
            new_node = Node(i)
            cur.next = new_node
            new_node.prev = cur
            cur = cur.next

        return DoubleLinkedList(head=head, tail=cur)


class Phone:
    def __init__(self, brand, color, price):
        self.brand = brand
        self.color = color
        self.price = price

    def __repr__(self):
        return "Phone:\n    Color: %s\n    Brand: %s\n    Price: %s\n" % (
            self.color,
            self.brand,
            self.price,
        )


class Stack:
    def __init__(self):
        self.data = []

    def push(self, item):
        self.data.append(item)

    def pop(self):
        return self.data.pop()


if __name__ == "__main__":
    pi = 3.14
    ultimate_answer = 42
    flag = True
    stock_price = [100, 99, 101, 1]
    fruits = {"apple", "peach", "watermelon"}
    country_to_capital_cities = {
        "China": "Beijing",
        "United Kingdom": "London",
        "Liyue": "Liyue Harbor",
    }

    # You can use dbg to inspect a lot of variables.
    dbg(
        pi,
        1 + 1,
        sorted(stock_price),
        "This string contains (, ' and ,",
        ultimate_answer,
        flag,  # You can leave a comment here as well, dbg() won't show this comment.
        stock_price,
        fruits,
        country_to_capital_cities,
    )

    # Or, you can use dbg to inspect one. Note that you can pass any keyword arguments originally supported by print()
    dbg(country_to_capital_cities, file=stderr)

    # You can also use dbg to inspect expressions.
    dbg(1 + 1)

    # When used with objects, it will show all fields contained by that object.
    double_linked_list = DoubleLinkedList.create(2)
    dbg(double_linked_list)

    # dbg() works with lists, tuples, and dictionaries.
    dbg(
        [double_linked_list, double_linked_list],
        (double_linked_list, double_linked_list),
        {"a": 1, "b": [double_linked_list]},
        [
            1,
            2,
            3,
            4,
        ],
    )

    # For even more complex structures, it works as well.
    stack = Stack()
    stack.push(double_linked_list)
    stack.push(double_linked_list)
    dbg(stack)

    dbg("What if my input is a string?")

    # If your type has its own __repr__ or __str__ implementation, no worries, crab_dbg will jut use it.
    phone = Phone("Apple", "white", 1099)
    dbg(phone)
    dbg({"my_phones": [phone]})

    # If you are extremely bored.
    infinite_list = []
    infinite_list.append(infinite_list)
    dbg(infinite_list)

    # If invoked without arguments, then it will just print the filename and line number.
    dbg()

    import numpy as np

    # This library can also be used with your favorite data science libraries if you enabled our optional features.
    ndarray = np.array([[1, 2, 3], [4, 5, 6]])
    dbg(ndarray)

    # And yes, even deeply nested ndarray is possible.
    stack = Stack()
    stack.push({"dict_key": ndarray})
    dbg(stack)