Player.from_userid caching

[satoon101]

• Added caching boolean argument for Player.from_userid.

[satoon101]

This came about because I was testing GunGame this morning and encountered an issue with gg_multi_level. I narrowed down the issue to the fact that the cache was causing me to get the same instance of _MultiLevelPlayer every time. There were other ways to fix it and use the cache, but I at least thought it would be a good idea to allow for caching=False through from_userid.

[jordanbriere]

Yes, makes sense for that method to forward that keyword. We should also add it to Entity.from_inthandle as well. Since it breaks compatibility, I believe we should default it to False here instead of True so that existing subclasses that were not implemented with caching in mind continues to works as they used to.

EDIT : I suggest to change that section to:

        # Set whether or not this class is caching its instances by default
        try:
            cls._caching = signature(
                vars(cls)['__init__']
            ).parameters['caching'].default
        except KeyError:
            cls._caching = vars(cls).get('caching', False)

To get the following behaviours:

class MyEntity(Entity):
    pass

print(MyEntity.caching) # False


class MyEntity(Entity):
    caching = True

print(MyEntity.caching) # True


class MyEntity(Entity):
    def __init__(self, index, caching=True):
        pass

print(MyEntity.caching) # True

Also, from_userid/from_inthandle should ideally default caching to None so that it internally follows cls.caching for subclasses.