Ggtcf

I have a Python script that handles Modbus communications. One feature I added was a "graph" that shows the response times along with a color coded line that indicates if the response was successful, had an exception, or an error. The graph is just a scrollable canvas widget from Tkinter.

After graphing a certain number of lines old lines will be deleted and then a new one will be added to the end. For this example I have it set to 10, which means there will never be more than 10 lines on the canvas at once.

The code works correctly but there is a memory leak somewhere in this function. I let it run for about 24 hours and it took about 6x more memory after 24 hours. The function is part of a larger class.

My current guess is that my code causes the canvas size to constantly "expand," which slowly eats up the memory.

self.lineList = []
self.xPos = 0

def UpdateResponseTimeGraph(self):
 if not self.graphQueue.empty():
 temp = self.graphQueue.get() #pull from queue. A separate thread handles calculating the length and color of the line. 
 self.graphQueue.task_done()

 lineName = temp[0] #assign queue values to variables
 lineLength = temp[1]
 lineColor = temp[2]

 if len(self.lineList) >= 10: #if more than 10 lines are on the graph, delete the first one.
 self.responseTimeCanvas.delete(self.lineList[0])
 del self.lineList[0]

 #Add line to canvas and a list so it can be referenced.
 self.lineList.append(self.responseTimeCanvas.create_rectangle(self.xPos, self.responseWidth, self.xPos + 4, self.responseWidth-lineLength, 
 fill=lineColor, outline=''))

 self.xPos += 5 #will cause the next line to start 5 pixels later. MEMORY LEAK HERE?

 self.responseTimeCanvas.config(scrollregion=self.responseTimeCanvas.bbox(ALL))

 self.responseTimeCanvas.xview_moveto(1.0) #move to the end of the canvas which is scrollable.



 self.graphFrame.after(10, self.UpdateResponseTimeGraph)

One solution could be loop back to the start of the graph once a limit is reached but I would rather not do this since it may be confusing where the graph starts. Usually I have far more responses than 10.

EDIT:

I'm still doing to trail and error stuff but it looks like the memory leak can be eliminated with Bryan's suggestion as long as the line attributes are not changed via itemconfig. The code below should be able to run as is, if you're on python 2.7 change the import statement from tkinter to Tkinter (lower case vs uppercase t). This code will have the memory leak in it. Comment out the itemconfig line and it will be eliminated.

import tkinter
from tkinter import Tk, Frame, Canvas, ALL
import random

def RGB(r, g, b):
 return '#:02x:02x:02x'.format(r, g, b)

class MainUI:
 def __init__(self, master):
 self.master = master
 self.lineList = []
 self.xPos = 0

 self.maxLine = 122

 self.responseIndex = 0 


 self.responseWidth = 100
 self.responseTimeCanvas = Canvas(self.master, height=self.responseWidth)
 self.responseTimeCanvas.pack()

 self.UpdateResponseTimeGraph()

 def UpdateResponseTimeGraph(self):
 self.lineLength = random.randint(10,99)

 if len(self.lineList) >= self.maxLine:
 self.lineLength = random.randint(5,95)
 self.responseTimeCanvas.coords(self.lineList[self.responseIndex % self.maxLine], self.xPos, self.responseWidth, self.xPos + 4, self.responseWidth-self.lineLength)

 #if i comment out the line below the memory leak goes away.
 self.responseTimeCanvas.itemconfig(self.lineList[self.responseIndex % self.maxLine], fill=RGB(random.randint(0,255), random.randint(0,255), random.randint(0,255)))
 else:
 self.lineList.append(self.responseTimeCanvas.create_rectangle(self.xPos, self.responseWidth, self.xPos + 4, self.responseWidth-self.lineLength, 
 fill=RGB(random.randint(0,255), random.randint(0,255), random.randint(0,255)), outline=''))


 self.xPos += 5 #will cause the next line to start 5 pixels later. MEMORY LEAK HERE?
 self.responseIndex += 1

 self.responseTimeCanvas.config(scrollregion=self.responseTimeCanvas.bbox(ALL))

 self.responseTimeCanvas.xview_moveto(1.0) #move to the end of the canvas which is scrollable.



 self.responseTimeCanvas.after(10, self.UpdateResponseTimeGraph)


mw = Tk()
mainUI = MainUI(mw)
mw.mainloop()

The underlying tk canvas doesn't reuse or recycle object identifiers. Whenever you create a new object, a new identifier is generated. The memory of these objects is never reclaimed.

Note: this is memory inside the embedded tcl interpreter, rather than memory managed by python.

The solution is to reconfigure old, no longer used elements rather than deleting them and creating new ones.

Here's the code with no memory leak. The original source of the leak was me deleting the old line then creating a new one. This solution moves the first the line to the end then change's its attributes as necessary. I had a second 'leak' in my example code where I was picking a random color each time which lead to the number of colors used eating up a lot of memory. This code just prints green lines but the length will be random.

import tkinter
from tkinter import Tk, Frame, Canvas, ALL
import random

def RGB(r, g, b):
 return '#:02x:02x:02x'.format(r, g, b)

class MainUI:
 def __init__(self, master):
 self.master = master
 self.lineList = []
 self.xPos = 0

 self.maxLine = 122

 self.responseIndex = 0 


 self.responseWidth = 100
 self.responseTimeCanvas = Canvas(self.master, height=self.responseWidth)
 self.responseTimeCanvas.pack()

 self.UpdateResponseTimeGraph()

 def UpdateResponseTimeGraph(self):
 self.lineLength = random.randint(10,99)

 if len(self.lineList) >= self.maxLine:
 self.lineLength = random.randint(5,95)
 self.responseTimeCanvas.coords(self.lineList[self.responseIndex % self.maxLine], self.xPos, self.responseWidth, self.xPos + 4, self.responseWidth-self.lineLength)

 self.responseTimeCanvas.itemconfig(self.lineList[self.responseIndex % self.maxLine], fill=RGB(100, 255, 100))
 else:
 self.lineList.append(self.responseTimeCanvas.create_rectangle(self.xPos, self.responseWidth, self.xPos + 4, self.responseWidth-self.lineLength, 
 fill=RGB(100, 255, 100), outline=''))


 self.xPos += 5 #will cause the next line to start 5 pixels later. 
 self.responseIndex += 1

 self.responseTimeCanvas.config(scrollregion=self.responseTimeCanvas.bbox(ALL))

 self.responseTimeCanvas.xview_moveto(1.0) #move to the end of the canvas which is scrollable.



 self.responseTimeCanvas.after(10, self.UpdateResponseTimeGraph)


mw = Tk()
mainUI = MainUI(mw)
mw.mainloop()