What does cls() function do inside a class method?

Question

Today I'm viewing another's code, and saw this:

class A(B): 
    # Omitted bulk of irrelevant code in the class

    def __init__(self, uid=None):
        self.uid = str(uid)

    @classmethod
    def get(cls, uid):
        o = cls(uid)
        # Also Omitted lots of code here

what does this cls() function do here?

If I got some other classes inherit this A class, call it C, when calling this get method, would this o use C class as the caller of cls()?

2

`cls` is `A` in this case. – Maroun Jul 17 '14 at 09:18

score 31 · Answer 1 · edited Jul 22 '18 at 23:12

31

cls is the constructor function, it will construct class A and call the __init__(self, uid=None) function.

If you enherit it (with C), the cls will hold 'C', (and not A), see AKX answer.

edited Jul 22 '18 at 23:12

ox12

17,618
20
63
121

answered Jul 17 '14 at 10:00

RvdK

19,128
3
59
105

score 17 · Answer 2 · answered Jul 17 '14 at 09:17

17

It's a class factory.

Essentially it the same as calling:

o = A(uid)

cls in def get(...): is A.

answered Jul 17 '14 at 09:17

James Mills

17,799
3
45
59

4

Feel free to suggest an improved edit. This is a community forum afterall. – James Mills Jul 23 '18 at 23:56
1

There is a large amount of expected knowledge in this answer. – Frank Robert Anderson Jun 06 '19 at 21:32

score 17 · Accepted Answer · answered Jul 17 '14 at 09:19

For classmethods, the first parameter is the class through which the class method is invoked with instead of the usual self for instancemethods (which all methods in a class implicitly are unless specified otherwise).

Here's an example -- and for the sake of exercise, I added an exception that checks the identity of the cls parameter.

class Base(object):
    @classmethod
    def acquire(cls, param):
        if cls is Base:
            raise Exception("Must be called via subclass :(")
        return "this is the result of `acquire`ing a %r with %r" % (cls, param)

class Something(Base):
    pass

class AnotherThing(Base):
    pass

print Something.acquire("example")
print AnotherThing.acquire("another example")
print Base.acquire("this will crash")

this is the result of `acquire`ing a <class '__main__.Something'> with 'example'
this is the result of `acquire`ing a <class '__main__.AnotherThing'> with 'another example'
Traceback (most recent call last):
  File "classmethod.py", line 16, in <module>
    print Base.acquire("this will crash")
  File "classmethod.py", line 5, in acquire
    raise Exception("Must be called via subclass :(")
Exception: Must be called via subclass :(

This doesn't really answer the OP's question as to what ``cls()`` does in the classmethod he has seen. As I've stated (@classmethods aside) it's a factory. — James Mills, Jul 17 '14 at 09:27

What does cls() function do inside a class method?

3 Answers3

Linked