"TypeError: method() takes 1 positional argument but 2 were given" but I only passed one
Asked Answered
S

12

515

If I have a class ...

class MyClass:

    def method(arg):
        print(arg)

... which I use to create an object ...

my_object = MyClass()

... on which I call method("foo") like so ...

>>> my_object.method("foo")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: method() takes exactly 1 positional argument (2 given)

... why does Python tell me I gave it two arguments, when I only gave one?

Swagerty answered 29/5, 2014 at 23:27 Comment(1)
That message has umpteen causes; the specific reason here is that all instance methods expect a first arg which by custom we call self. So declaring def method(arg): is wrong for a method, it should be def method(self, arg):. When the method dispatch tries to call method(arg): and match up two parameters self, arg against it, you get that error.Anoxia
S
640

In Python, this:

my_object.method("foo")

... is syntactic sugar, which the interpreter translates behind the scenes into:

MyClass.method(my_object, "foo")

... which, as you can see, does indeed have two arguments - it's just that the first one is implicit, from the point of view of the caller.

This is because most methods do some work with the object they're called on, so there needs to be some way for that object to be referred to inside the method. By convention, this first argument is called self inside the method definition:

class MyNewClass:

    def method(self, arg):
        print(self)
        print(arg)

If you call method("foo") on an instance of MyNewClass, it works as expected:

>>> my_new_object = MyNewClass()
>>> my_new_object.method("foo")
<__main__.MyNewClass object at 0x29045d0>
foo

Occasionally (but not often), you really don't care about the object that your method is bound to, and in that circumstance, you can decorate the method with the builtin staticmethod() function to say so:

class MyOtherClass:

    @staticmethod
    def method(arg):
        print(arg)

... in which case you don't need to add a self argument to the method definition, and it still works:

>>> my_other_object = MyOtherClass()
>>> my_other_object.method("foo")
foo
Swagerty answered 29/5, 2014 at 23:27 Comment(4)
In short: Adding self as first argument to the method solves the problem.Droughty
or just adding @staticmethod before defining it. CoolSaskatchewan
Can you elaborate a bit on this bit here: "Occasionally (but not often), you really don't care about the object that your method is bound to..." I come from a Java and .NET background, and I frequently organize methods into appropriate classes for grouping/organization. Would that not be valid here in Python as well?Sulcus
@Sulcus in Python you'd typically use modules and packages to group functions, not classes.Swagerty
D
49

In simple words

In Python you should add self as the first parameter to all defined methods in classes:

class MyClass:
  def method(self, arg):
    print(arg)

Then you can use your method according to your intuition:

>>> my_object = MyClass()
>>> my_object.method("foo")
foo

For a better understanding, you can also read the answers to this question: What is the purpose of self?

Diode answered 19/6, 2019 at 9:44 Comment(3)
What's wrong with this answer? Why did someone give her a negative point? After all, it is the answer to the question and is distinguished by its simplicity compared to other answers, which may be important for some people who are looking for an answer. Isn't it?Diode
It's wrong to say that you should add self argument to ALL defined methods in classes. In the example above there is no use for self inside the method, therefore it can be decorated with @staticmethod which in turn wouldn't require you to create an instance of the class. You can read more about it here: docs.python.org/3/library/…Haunt
It's also possible to have @classmethods, which take cls as their first parameter, not self.Eggnog
G
25

Something else to consider when this type of error is encountered:

I was running into this error message and found this post helpful. Turns out in my case I had overridden an __init__() where there was object inheritance.

The inherited example is rather long, so I'll skip to a more simple example that doesn't use inheritance:

class MyBadInitClass:
    def ___init__(self, name):
        self.name = name

    def name_foo(self, arg):
        print(self)
        print(arg)
        print("My name is", self.name)


class MyNewClass:
    def new_foo(self, arg):
        print(self)
        print(arg)


my_new_object = MyNewClass()
my_new_object.new_foo("NewFoo")
my_bad_init_object = MyBadInitClass(name="Test Name")
my_bad_init_object.name_foo("name foo")

Result is:

<__main__.MyNewClass object at 0x033C48D0>
NewFoo
Traceback (most recent call last):
  File "C:/Users/Orange/PycharmProjects/Chapter9/bad_init_example.py", line 41, in <module>
    my_bad_init_object = MyBadInitClass(name="Test Name")
TypeError: object() takes no parameters

PyCharm didn't catch this typo. Nor did Notepad++ (other editors/IDE's might).

Granted, this is a "takes no parameters" TypeError, it isn't much different than "got two" when expecting one, in terms of object initialization in Python.

Addressing the topic: An overloading initializer will be used if syntactically correct, but if not it will be ignored and the built-in used instead. The object won't expect/handle this and the error is thrown.

In the case of the sytax error: The fix is simple, just edit the custom init statement:

def __init__(self, name):
    self.name = name
Griffe answered 4/1, 2016 at 4:33 Comment(3)
There's no SyntaxError here. The code is syntactically correct; it just correctly defines a method named ___init__, which nobody is ever going to call, instead of the special method __init__. That's why no error is detected—because there isn't one to detect.Neilneila
Exact same thing happened to me, but with __int__(self, ...):. Hours wasted because of that typo.Rebato
I'm happy you found a solution, but this is a totally different issue than the one in the question. I would say you could post your own question, but the same sort of thing has already been posted, for example: "This constructor takes no arguments" error in __init__ (typo was _init_).Eggnog
P
21

This issue can also be caused by failing to pass keyword arguments to a function properly.

For example, given a method defined like:

def create_properties_frame(self, parent, **kwargs):

a call like this:

self.create_properties_frame(frame, kw_gsp)

will cause TypeError: create_properties_frame() takes 2 positional arguments but 3 were given, because the kw_gsp dictionary is treated as a positional argument instead of being unpacked into separate keyword arguments.

The solution is to add ** to the argument:

self.create_properties_frame(frame, **kw_gsp)
Possum answered 28/7, 2019 at 9:43 Comment(2)
Coming from JavaScript, I expect to be able to pass a list or dictionary as an argument. But it seems like that's not how Python works: you have to destructure the list with * or **, the latter being for a keyworded argument list.Suited
@LittleBrain: yes you can pass a list (or dict) if you want them to be treated as a list (/dict) inside the function. But if you want their individual values unpacked and matched against args (/kwargs) in the function, then you need the *args (/**kwargs) syntax.Anoxia
G
15

As mentioned in other answers - when you use an instance method you need to pass self as the first argument - this is the source of the error.

With addition to that,it is important to understand that only instance methods take self as the first argument in order to refer to the instance.

In case the method is Static you don't pass self, but a cls argument instead (or class_).

Please see an example below.

class City:

   country = "USA" # This is a class level attribute which will be shared across all instances  (and not created PER instance)

   def __init__(self, name, location, population):
       self.name       = name
       self.location   = location
       self.population = population
 
   # This is an instance method which takes self as the first argument to refer to the instance 
   def print_population(self, some_nice_sentence_prefix):
       print(some_nice_sentence_prefix +" In " +self.name + " lives " +self.population + " people!")

   # This is a static (class) method which is marked with the @classmethod attribute
   # All class methods must take a class argument as first param. The convention is to name is "cls" but class_ is also ok
   @classmethod
   def change_country(cls, new_country):
       cls.country = new_country

Some tests just to make things more clear:

# Populate objects
city1 = City("New York",    "East", "18,804,000")
city2 = City("Los Angeles", "West", "10,118,800")

#1) Use the instance method: No need to pass "self" - it is passed as the city1 instance
city1.print_population("Did You Know?") # Prints: Did You Know? In New York lives 18,804,000 people!

#2.A) Use the static method in the object
city2.change_country("Canada")

#2.B) Will be reflected in all objects
print("city1.country=",city1.country) # Prints Canada
print("city2.country=",city2.country) # Prints Canada
Gayn answered 1/7, 2020 at 19:45 Comment(3)
This terminology is wrong. classmethods and staticmethods are two different things. classmethods take cls while staticmethods don't have any required parameters.Eggnog
Also, I don't think this is a good example of a classmethod, because why would you want one City instance to affect all others? Like, why does the City class even have a country attribute in the first place? Shouldn't each City instance define its own country? Say I wanted to make a City instance for Tokyo and another for Toronto; that's not possible with this, so how is it useful? Here's a better example, including a staticmethod.Eggnog
Thanks @wjandrea, I'm not 100% sure I understood your comments and why my answer is giving a wrong information in any way.Gayn
C
9

It occurs when you don't specify the no of parameters the __init__() or any other method looking for.

For example:

class Dog:
    def __init__(self):
        print("IN INIT METHOD")

    def __unicode__(self,):
        print("IN UNICODE METHOD")

    def __str__(self):
        print("IN STR METHOD")

obj = Dog("JIMMY", 1, 2, 3, "WOOF")

When you run the above programme, it gives you an error like that:

TypeError: __init__() takes 1 positional argument but 6 were given

How we can get rid of this thing?

Just pass the parameters, what __init__() method looking for

class Dog:
    def __init__(self, dogname, dob_d, dob_m, dob_y, dogSpeakText):
        self.name_of_dog = dogname
        self.date_of_birth = dob_d
        self.month_of_birth = dob_m
        self.year_of_birth = dob_y
        self.sound_it_make = dogSpeakText

    def __unicode__(self, ):
        print("IN UNICODE METHOD")

    def __str__(self):
        print("IN STR METHOD")


obj = Dog("JIMMY", 1, 2, 3, "WOOF")
print(id(obj))
Capello answered 3/2, 2017 at 3:45 Comment(0)
G
6

If you want to call method without creating object, you can change method to static method.

class MyClass:

    @staticmethod
    def method(arg):
        print(arg)

MyClass.method("i am a static method")
Gingrich answered 12/8, 2021 at 14:40 Comment(0)
A
5

I get this error when I'm sleep-deprived, and create a class using def instead of class:

def MyClass():
    def __init__(self, x):
        self.x = x

a = MyClass(3)
-> TypeError: MyClass() takes 0 positional arguments but 1 was given
Armada answered 9/3, 2021 at 14:43 Comment(3)
I'm happy you found a solution, but this is a totally different issue than the one in the question. I would say you could post your own question, but the same thing has already been posted: TypeError: __init__ takes 1 positional argument but 2 were given.Eggnog
@wjandrea, this answer is for the exact error message of the subject. I don't know about you, but I don't read questions, I read the subject and answers.Inesita
@Inesita Yeah, it's best to read the whole question, but I do skip it myself sometimes. So, I've updated the title to better reflect the problem.Eggnog
P
-1

You should actually create a class:

class accum:
    def __init__(self):
        self.acc = 0
    def accumulator(self, var2add, end):
        if not end:
            self.acc+=var2add
        return self.acc
Pazice answered 17/1, 2020 at 17:16 Comment(1)
How does this answer the question?Eggnog
T
-1

In my case, I forgot to add the ()

I was calling the method like this

obj = className.myMethod

But it should be is like this

obj = className.myMethod()
Tyra answered 5/6, 2020 at 19:36 Comment(2)
I'm not following. How would that cause the error in the question?Eggnog
It just worked.Tyra
E
-1

If you experience this with Django then this is what it implies:

  1. add an object to the function, Django will understand the rest, example
def display_genre(self, obj):
        return ', '.join(genre.name for genre in obj.genre.all())}

Elusive answered 30/3, 2023 at 11:29 Comment(0)
C
-1

You may also get the same error message if a function takes one positional argument and any additional variables as keyword arguments. To resolve the issue, pass the additional variables as keywords arguments.

An example that triggers the error:

def func(value, **kwargs):
    pass

func(1, 2)   # <--- TypeError: func() takes 1 positional argument but 2 were given

func(1, b=2) # <--- OK

Another more practical example: django's authenticate() method can be used to verify credentials such as username and password but it takes them as keyword arguments (docs, source code), so the following scenario comes up:

from django.contrib.auth import authenticate
authenticate(username, password)                    # <--- TypeError
authenticate(username=username, password=password)  # <--- OK
Cytogenetics answered 21/9, 2023 at 21:55 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.