CODEWITHSUNDEEP
pythondestructorshutdown
Dan
Dan

Reputation: 35453

Method that gets called on module deletion in Python

Is there a method that I can add to my module, which will get called when destructing the class?

We have a simple class which has only static member functions and needs to clean up the database connection when unloading the module.

Was hoping there would be a __del__ method either for modules or classes that don't have instances?

Upvotes: 12

Views: 8001

Answers (4)

user2153867
user2153867

Reputation: 1

Tested using bpython...

>>> import atexit
>>> class Test( object ):
...     @staticmethod
...     def __cleanup__():
...         print("cleanup")
...     atexit.register(Test.__cleanup__)
... 
Traceback (most recent call last):
  File "<input>", line 1, in <module>
  File "<input>", line 6, in Test
NameError: name 'Test' is not defined

Upvotes: -1

nosklo
nosklo

Reputation: 222862

When destructing which class? I though you said module?

Your module lives until the interpreter stops. you can add something to run at that time using the "atexit" module:

import atexit
atexit.register(myfunction)

EDIT: Based on your comments.

Since you don't want it as a destructor, my answer above is correct. Just def another function (or static method if you wish) and register it with the atexit:

def close_database():
    proceed_to_close()

import atexit
atexit.register(close_database)

Now a quick note on your definition.

You said the class doesn't have any instances. So why make it a class? Why not define the functions in the module level instead? modules are first-class objects, cached and imported only once...

Example, instead of defining database.py:

class DataBase(object):
    @staticmethod
    def execute_some_query(query):
        code_here()
        some_code()
    @staticmethod
    def close_database():
        proceed_to_close()
import atexit ; atexit.register(DataBase.close_database)

and using:

from database import DataBase
DataBase.execute_some_query(query)

You could do this instead on database.py:

def execute_some_query(query):
    code_here()
    some_code()

def close_database():
    proceed_to_close()
import atexit ; atexit.register(close_database)

And use it like this:

import database
database.execute_some_query(query)

Or better yet: Use sqlalchemy and avoid all this trouble of creating your own database interface.

Upvotes: 23

Jarret Hardie
Jarret Hardie

Reputation: 97952

The class destructor method you're looking for is __del__. There are some nuances to when it's called, and to how exceptions and subclassing should be handled in __del__, so be sure to read the official docs.

A quick note on terminology, too: in python a module is the file in which your code is located... a namespace, in essence. A single module can contain many classes, variables, and functions. The __del__ method is located on the class, not on the module.

Upvotes: 1

ismail
ismail

Reputation: 47602

Use the del method:

class Foo:

    def __init__(self):
        print "constructor called."

    def __del__(self):
        print "destructor called."

Upvotes: -1

Related Questions