Added cached properties implementation.

Author: jordanbriere

addons/source-python/docs/source-python/source/developing/modules/core.cache.rst

@@ -0,0 +1,12 @@
+core.cache module
+==================
+
+.. automodule:: core.cache
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: _core._cache.CachedProperty
+    :members:
+    :undoc-members:
+    :show-inheritance:

addons/source-python/packages/source-python/core/cache.py

@@ -0,0 +1,25 @@
+# ../core/cache.py
+
+"""Provides caching functionality.
+
+.. data:: cached_property
+    An alias of :class:`core.cache.CachedProperty`.
+"""
+
+
+# =============================================================================
+# >> FORWARD IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Core
+from _core._cache import CachedProperty
+from _core._cache import cached_property
+
+
+# =============================================================================
+# >> ALL DECLARATION
+# =============================================================================
+__all__ = [
+    'CachedProperty',
+    'cached_property'
+]

addons/source-python/packages/source-python/entities/_base.py

@@ -17,6 +17,7 @@
 #   Core
 from core import GAME_NAME
 from core import BoostPythonClass
+from core.cache import cached_property
 #   Entities
 from entities.constants import INVALID_ENTITY_INDEX
 #   Engines
@@ -295,7 +296,7 @@ def is_networked(self):
         """
         return True
 
-    @property
+    @cached_property
     def index(self):
         """Return the entity's index.
 
@@ -316,30 +317,30 @@ def owner(self):
         except (ValueError, OverflowError):
             return None
 
-    @property
+    @cached_property
     def server_classes(self):
         """Yield all server classes for the entity."""
         yield from server_classes.get_entity_server_classes(self)
 
-    @property
+    @cached_property
     def properties(self):
         """Iterate over all descriptors available for the entity."""
         for server_class in self.server_classes:
             yield from server_class.properties
 
-    @property
+    @cached_property
     def inputs(self):
         """Iterate over all inputs available for the entity."""
         for server_class in self.server_classes:
             yield from server_class.inputs
 
-    @property
+    @cached_property
     def outputs(self):
         """Iterate over all outputs available for the entity."""
         for server_class in self.server_classes:
             yield from server_class.outputs
 
-    @property
+    @cached_property
     def keyvalues(self):
         """Iterate over all entity keyvalues available for the entity.
 

addons/source-python/packages/source-python/players/_base.py

@@ -14,6 +14,7 @@
 from bitbuffers import BitBufferWrite
 #   Core
 from core import GAME_NAME
+from core.cache import cached_property
 #   Engines
 from engines.server import server
 from engines.server import engine_server
@@ -89,7 +90,6 @@ def __init__(self, index, caching=True):
         """
         PlayerMixin.__init__(self, index)
         Entity.__init__(self, index)
-        object.__setattr__(self, '_playerinfo', None)
 
     @classmethod
     def from_userid(cls, userid):
@@ -101,7 +101,7 @@ def from_userid(cls, userid):
         """
         return cls(index_from_userid(userid))
 
-    @property
+    @cached_property
     def raw_steamid(self):
         """Return the player's unformatted SteamID.
 
@@ -117,26 +117,23 @@ def permissions(self):
         """
         return auth_manager.get_player_permissions_from_steamid(self.steamid)
 
-    @property
+    @cached_property
     def playerinfo(self):
         """Return player information.
 
         :rtype: PlayerInfo
         """
-        if self._playerinfo is None:
-            playerinfo = playerinfo_from_index(self.index)
-            object.__setattr__(self, '_playerinfo', playerinfo)
-        return self._playerinfo
+        return playerinfo_from_index(self.index)
 
-    @property
+    @cached_property
     def userid(self):
         """Return the player's userid.
 
         :rtype: int
         """
         return self.playerinfo.userid
 
-    @property
+    @cached_property
     def steamid(self):
         """Return the player's SteamID.
 
@@ -157,15 +154,15 @@ def set_name(self, name):
 
     name = property(get_name, set_name)
 
-    @property
+    @cached_property
     def client(self):
         """Return the player's client instance.
 
         :rtype: Client
         """
         return server.get_client(self.index - 1)
 
-    @property
+    @cached_property
     def base_client(self):
         """Return the player's base client instance.
 
@@ -174,15 +171,15 @@ def base_client(self):
         from players import BaseClient
         return make_object(BaseClient, get_object_pointer(self.client) - 4)
 
-    @property
+    @cached_property
     def uniqueid(self):
         """Return the player's unique ID.
 
         :rtype: str
         """
         return uniqueid_from_playerinfo(self.playerinfo)
 
-    @property
+    @cached_property
     def address(self):
         """Return the player's IP address and port.
 
@@ -208,13 +205,15 @@ def is_fake_client(self):
         """
         return self.playerinfo.is_fake_client()
 
+    @cached_property
     def is_hltv(self):
         """Return whether the player is HLTV.
 
         :rtype: bool
         """
         return self.playerinfo.is_hltv()
 
+    @cached_property
     def is_bot(self):
         """Return whether the player is a bot.
 
@@ -249,7 +248,7 @@ def set_team(self, value):
 
     team = property(get_team, set_team)
 
-    @property
+    @cached_property
     def language(self):
         """Return the player's language.
 

src/CMakeLists.txt

@@ -153,6 +153,15 @@ Set(SOURCEPYTHON_CORE_MODULE_SOURCES
     core/modules/core/core_wrap.cpp
 )
 
+Set(SOURCEPYTHON_CORE_CACHE_MODULE_HEADERS
+    core/modules/core/core_cache.h
+)
+
+Set(SOURCEPYTHON_CORE_CACHE_MODULE_SOURCES
+    core/modules/core/core_cache.cpp
+    core/modules/core/core_cache_wrap.cpp
+)
+
 # ------------------------------------------------------------------
 # Cvars module.
 # ------------------------------------------------------------------
@@ -466,6 +475,9 @@ Set(SOURCEPYTHON_WEAPONS_MODULE_SOURCES
 # All module source files
 # ------------------------------------------------------------------
 Set(SOURCEPYTHON_MODULE_FILES
+    ${SOURCEPYTHON_CORE_CACHE_MODULE_HEADERS}
+    ${SOURCEPYTHON_CORE_CACHE_MODULE_SOURCES}
+
     # CFunctionInfo must be exposed at first
     ${SOURCEPYTHON_MEMORY_MODULE_HEADERS}
     ${SOURCEPYTHON_MEMORY_MODULE_SOURCES}