How can static method access class variable in Python?

Question

This is what my code looks like

class InviteManager():
    ALREADY_INVITED_MESSAGE = "You are already on our invite list"
    INVITE_MESSAGE = "Thank you! we will be in touch soon"

    @staticmethod
    @missing_input_not_allowed
    def invite(email):
        try:
            db.session.add(Invite(email))
            db.session.commit()
        except IntegrityError:
            return ALREADY_INVITED_MESSAGE
        return INVITE_MESSAGE

When I run my tests, I see

NameError: global name 'INVITE_MESSAGE' is not defined

How can I access INVITE_MESSAGE inside @staticmethod?

Fred Foo · Accepted Answer · 2013-08-25 16:51:27Z

75

You can access it as InviteManager.INVITE_MESSAGE, but a cleaner solution is to change the static method to a class method:

@classmethod
@missing_input_not_allowed
def invite(cls, email):
    return cls.INVITE_MESSAGE

(Or, if your code is really as simple as it looks, you can replace the whole class with a bunch of functions and constants in a module. Modules are namespaces.)

answered Aug 25, 2013 at 16:51

Fred Foo

365k80 gold badges765 silver badges852 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

user395760 Over a year ago

Or just make it a module-level function.

Fred Foo Over a year ago

@delnan: yes. Sometimes you need a class or static method, though, in particular in situations involving inheritance or duck typing.

JavaSa Over a year ago

Any idea why python allows to access class variable via staticmethod? If so why do we need classmethod? What is the different use case between classmethod and staticmethod if they both can access the class variables?

antont Over a year ago

class methods get a reference to the subclass, so they can be written in a baseclass but work differently in different subclasses, as they behaviour can depend on the class. also, static methods don't get a reference to the class, so using cls is cleaner if you need to refer the class at all, for example as the code does not break if the name of the class changes.

Maciej Gol · Accepted Answer · 2013-08-25 16:51:03Z

13

Try:

class InviteManager():
    ALREADY_INVITED_MESSAGE = "You are already on our invite list"
    INVITE_MESSAGE = "Thank you! we will be in touch soon"

    @staticmethod
    @missing_input_not_allowed
    def invite(email):
        try:
            db.session.add(Invite(email))
            db.session.commit()
        except IntegrityError:
            return InviteManager.ALREADY_INVITED_MESSAGE
        return InviteManager.INVITE_MESSAGE

The InviteManager is in the scope of it's staticmethods.

answered Aug 25, 2013 at 16:51

Maciej Gol

15.9k4 gold badges35 silver badges52 bronze badges

Comments

Mohsen Banan · Accepted Answer · 2021-10-14 02:46:01Z

12

It is much simpler than all of that:

Just added __class__ to the class variables. Like so:

return __class__.ALREADY_INVITED_MESSAGE
        return __class__.INVITE_MESSAGE

There is no need to mention the ClassName (InviteManager) and there is no need to use a classmethod

edited Oct 14, 2021 at 2:46

answered Oct 14, 2021 at 1:50

Mohsen Banan

1531 silver badge6 bronze badges

1 Comment

eugenhu Over a year ago

More information: The __class__ cell was introduced in PEP 3135.

Community · Accepted Answer · 2017-05-23 11:54:37Z

6

Just realized, I needed @classmethod

class InviteManager():
    ALREADY_INVITED_MESSAGE = "You are already on our invite list"
    INVITE_MESSAGE = "Thank you! we will be in touch soon"

    @classmethod
    @missing_input_not_allowed
    def invite(cls, email):
        try:
            db.session.add(Invite(email))
            db.session.commit()
        except IntegrityError:
            return cls.ALREADY_INVITED_MESSAGE
        return cls.INVITE_MESSAGE

You can read about it here

edited May 23, 2017 at 11:54

CommunityBot

11 silver badge

answered Aug 25, 2013 at 16:51

daydreamer

92.9k204 gold badges476 silver badges754 bronze badges

Comments

OneCricketeer · Accepted Answer · 2023-01-30 19:10:11Z

5

Simply, understand the concept of class level variables/methods and instance level variables/methods.

While working with static methods, you won't use self keyword as self keyword is used to represent instance of the class or to use instance variables of the class. In fact one use class_name, see below example:

class Myclass():
    msg = "Hello World!"

    @staticmethod
    def printMsg():
        print(Myclass.msg)



Myclass.printMsg() #Hello World!
print(Myclass.msg) #Hello World!
Myclass.msg = "Hello Neeraj!"
Myclass.printMsg() #Hello Neeraj!
print(Myclass.msg) #Hello Neeraj!

edited Jan 30, 2023 at 19:10

OneCricketeer

193k20 gold badges146 silver badges276 bronze badges

answered Apr 7, 2019 at 6:20

Neeraj Bansal

2,8661 gold badge19 silver badges9 bronze badges

Comments

Maxime Lorant · Accepted Answer · 2013-08-25 16:51:35Z

2

You can access to yours attributes with InviteManager.INVITE_MESSAGE and InviteManager.ALREADY_INVITED_MESSAGE without changing anything in their declaration.

answered Aug 25, 2013 at 16:51

Maxime Lorant

36.4k19 gold badges91 silver badges97 bronze badges

Collectives™ on Stack Overflow

How can static method access class variable in Python?

6 Answers 6

4 Comments

Comments

1 Comment

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

4 Comments

Comments

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related