How to define a method like int.from_bytes() in Python?

Question

In python there is a method on the type int, namely int.from_bytes. It's not a method on a particular int, instead it's a method on the type. E.g.

>>> int.from_bytes(b'\xee\xff',"big")
61183

>>> int.from_bytes
<built-in method from_bytes of type object at 0x107fdb388>

How do I define something like this? Let's say a class called "point" is defined, how do I define something like

>>> point.from_coordinates(3,5)
<__main__.point object at 0x10c0c9310>

>>> point.from_keys(b'\x12\x3e')
<__main__.point object at 0x10bed5890>

? (Assuming points are initialized by some different method.)

possible duplicate of Python @classmethod and @staticmethod for beginner? — Bakuriu
– Bakuriu, Commented Jun 24, 2013 at 20:29

abarnert · Accepted Answer · 2013-06-24 20:26:35Z

6

You want classmethod, which is normally used as a decorator:

class point(object):
    @classmethod
    def from_coordinates(cls, x, y):
        pt = cls()
        pt.x, pt.y = x, y
        return pt

This is sometimes called the "alternate constructor" idiom. If there are multiple different ways to construct your type, instead of putting them all into one __init__ method with a mess of optional parameters or varags, put them all into separate classmethods.

answered Jun 24, 2013 at 20:26

abarnert

368k54 gold badges626 silver badges691 bronze badges

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

Comments

Jon Clements · Accepted Answer · 2013-06-24 20:27:55Z

3

You can use a classmethod, such as the mocked up example whose init expects ints, but also provides a convenient from_hex that tries to take strings and convert them to integers...

class MyClass(object):
    def __init__(self, a, b):
        self.a = a
        self.b = b
    @classmethod
    def from_hex(cls, a, b):
        return cls(int(a, 16), int(b, 16))

The from_hex knows which class it is associated with, so by calling cls(...) you're able to construct a type of MyClass as though you'd written MyClass(a, b) with valid integers yourself.

answered Jun 24, 2013 at 20:27

Jon Clements

143k34 gold badges254 silver badges288 bronze badges

Collectives™ on Stack Overflow

How to define a method like int.from_bytes() in Python?

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related