Using self.* as default value for a method

Question:

def save_file(self, outputfilename = self.image_filename): 
    self.file.read(outputfilename)
    ....

gives NameError: name 'self' is not defined in the first line. It seems that Python doesn’t accept it. How can I rewrite the code so it doesn’t raise an exception?

Asked By: Framester

||

Answers:

def save_file(self, outputfilename = None):
    if not outputfilename:
        outputfilename = self.image_filename 
    self.file.read(outputfilename)
    ....
Answered By: Alexander Poluektov

Use a default of None and detect that.

def save_file(self, outputfilename=None): 
    if outputfilename is None:
        outputfilename = self.image_filename
    self.file.read(outputfilename)
    ....

The documentation states:

Default parameter values are evaluated when the function definition is executed.

This explains why the instance cannot be referenced. As others have said, use None as your default and fix up the value at function execution time when the instance is available.

Answered By: David Heffernan
def save_file(self, outputfilename=None): 
    outputfilename = outputfilename or self.image_filename
    self.file.read(outputfilename)

or even

def save_file(self, outputfilename=None):         
    self.file.read(outputfilename or self.image_filename)

This may be nothing with one variable, but if you have, let’s say, 5, this makes code easier to read, in my opinion.

Answered By: petr0
Categories: questions Tags:
Answers are sorted by their score. The answer accepted by the question owner as the best is marked with
at the top-right corner.