Python Logging Instead of Print For Debugging

Debugging is the process of finding and fixing errors in your code. Print statements are a common way to debug by printing out values or messages to the console. However, print statements have some limitations and drawbacks:

They can clutter up your code and make it less readable.

They can affect the performance of your program by slowing it down or changing its behavior.

They can be hard to manage when you have multiple print statements in different modules or functions.

They can be lost or overwritten when you run your program in different environments or platforms.

Logging is a better alternative to print statements for debugging because it allows you to:

Control the level of detail and format of your output by using different log levels (such as DEBUG, INFO, WARNING, ERROR, CRITICAL) and handlers (such as StreamHandler, FileHandler, etc.).

Filter out unwanted messages by using loggers (such as root logger, named logger) and filters.

Record useful information such as timestamps, module names, line numbers, function names, etc. by using formatters.

Save your output to a file or send it to other destinations such as email, database, etc. by using handlers.

To use logging in Python, you need to import the logging module and configure it according to your needs. Here is a simple example:


import logging

# Configure logging
logging.basicConfig(filename="debug.log", level=logging.DEBUG)

# Create a logger object
logger = logging.getLogger("example")

# Log some messages
logger.debug("This is a debug message")
logger.info("This is an info message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")

This will create a file named debug.log that contains something like this:

DEBUG:example:This is a debug message
INFO:example:This is an info message
WARNING:example:This is a warning message
ERROR:example:This is an error message
CRITICAL:example:This is a critical message

# Logging Code For Zero Division Error
import logging
a = 10
b = 0
try:
  c = a / b
except Exception as e:
  logging.error("Exception Occurred", exc_info=True) # At default it is True

# Console output
ERROR:root:Exception Occurred  # If exc_info=False then only this message will print
Traceback (most recent call last):
  File "C:\Users\Name\Desktop\logging_code.py", line 5, in <module>
    c = a / b
ZeroDivisionError: division by zero

# Console output
Traceback (most recent call last):
  File "main.py", line 3, in <module>
    print(a/b)
ZeroDivisionError: division by zero

I hope this helps you understand how to use logging instead of print for debugging in Python. Do you have any questions or feedback?

Comments

Post a Comment

Popular posts from this blog

Python chr() Built in Function

The Python chr() function is used to get a string representing a character that corresponds to a Unicode code integer. For example, chr(97) returns the string 'a'. This function takes an integer argument and throws an error if it exceeds the range of 0 to 1,114,111. Here are some examples of using the chr() function in Python: # Get the character for ASCII code 65 print(chr(65)) # Output: A # Get the character for Unicode code point 1200 print(chr(1200)) # Output: Ұ # Get the characters for a list of integers codes = [71, 101, 101, 107, 115] chars = [chr(code) for code in codes] print(''.join(chars)) # Output: Geeks To print ‘Hello World’ using chr() , you can write: print(chr(72) + chr(101) + chr(108) + chr(108) + chr(111) + chr(32) + chr(87) + chr(111) + chr(114) + chr(108) + chr(100)) To print a list of all uppercase letters using chr() , you can write: letters = [] for i in range(65, 91):     letters.append(chr(i)) print(letters) To print a smiley face emoji...
Read more

Stock Market Predictions with LSTM in Python

Stock Market Predictions with LSTM in Python is a tutorial that shows how to create a three-layer LSTM model using TensorFlow and Keras. Here is a snippet of how to define the model: # Define the LSTM model model = Sequential() model.add(LSTM(units=50, return_sequences=True, input_shape=(x_train.shape[1], 1))) model.add(LSTM(units=50)) model.add(Dense(1))   # Compile and fit the model model.compile(loss='mean_squared_error', optimizer='adam') model.fit(x_train, y_train, epochs=25, batch_size=32) Stock Market Analysis + Prediction using LSTM is a notebook that shows how to load stock market data from Yahoo finance using yfinance module, how to explore and visualize time-series data using pandas, matplotlib, and seaborn, how to measure the correlation between stocks, how to measure the risk of investing in a particular stock, and how to use LSTM (Long Short-Term Memory) model for predicting future stock prices. Here is a snippet of how to create and train an LSTM model f...
Read more

Collections In Python

Python collections are data structures that store multiple items of the same or different types. There are four built-in collection types in Python: list, tuple, set and dictionary. Additionally, there is a module called collections that provides more specialized collection types such as Counter, OrderedDict, defaultdict and namedtuple. Here are some examples of using Python collections: List: A list is a collection that is ordered and changeable. The Python lists are defined with square brackets. # Create a list of fruits fruits = ["apple", "banana", "cherry"] # Print the list print(fruits) # Output: ['apple', 'banana', 'cherry'] Tuple: A tuple is a collection that is ordered and unchangeable. The Python tuples are written with round brackets. # Create a tuple of colors colors = ("red", "green", "blue") # Print the tuple print(colors) # Output: ('red', 'green', 'blue') Set: A...
Read more

Python Count Occurrence Of Elements

There are several ways to count the occurrence of elements in a Python list. One way is to use the list.count() method which takes an element as an argument and returns the number of times it appears in the list. For example: a = [1, 2, 3, 4, 1, 2, 1] b = a.count(1) # b is 3 c = a.count(5) # c is 0 Another way is to use a loop and a counter variable to iterate over the list and increment the counter whenever the element is found. For example: a = [1, 2, 3, 4, 1, 2, 1] x = 1 count = 0 for ele in a:     if ele == x:         count += 1 # count is 3  A third way is to use a dictionary or a defaultdict to store the elements as keys and their counts as values. For example: from collections import defaultdict a = [1, 2, 3, 4, 1 ,2 ,1] occurrence = defaultdict(lambda:0) for ele in a:     occurrence[ele] += 1 # occurrence is {1:3 ,2:2 ,3:1 ,4:1} It is good to have an idea of the number of times elements occurred in your data...
Read more

Python One Liner Functions

Python one-liner functions are functions that can be written in a single line of code. They are often used to perform simple tasks or expressions without defining a named function. One way to create a one-liner function is to use the lambda keyword which creates an anonymous function that takes some arguments and returns a value. For example: # A lambda function that returns the square of a number square = lambda x: x**2 print(square(5)) # 25 # A lambda function that checks if a number is even is_even = lambda x: x%2 == 0 print(is_even(4)) # True Another way to create a one-liner function is to use the def keyword with a colon and an expression after it. This creates a named function that returns the value of the expression. For example: # A one-liner function that returns the sum of two numbers def add(x, y): return x + y print(add(3, 4)) # 7 # A one-liner function that reverses a string def reverse(s): return s[::-1] print(reverse("hello")) # olleh Python offers a one-l...
Read more