Added back CachedProperty.owner as a weak reference.

Reverted EntityMemFuncWrapper back to be bound and store a proxy of the wrapped instance. My tests were not leaking because the hash was matching so the cache was re-used but no matter where we cache the value, it will still keep the instance hostage if it strongly refers it. Left the unbound implementation in place, as it can be useful in other cases.
Added unbound parameter to CachedProperty.wrap_descriptor.
Updated docstrings and signatures.

Author: jordanbriere

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

@@ -5,6 +5,10 @@
 # =============================================================================
 # >> IMPORTS
 # =============================================================================
+# Python Imports
+#   WeakRef
+from weakref import proxy
+
 # Source.Python Imports
 #   Core
 from core.cache import CachedProperty
@@ -97,7 +101,7 @@ def __init__(self, wrapped_self, wrapper):
         func = wrapped_self.__getattr__(wrapper.__name__)
         super().__init__(func._manager, func._type_name, func, func._this)
         self.wrapper = wrapper
-        self.wrapped_self = wrapped_self
+        self.wrapped_self = proxy(wrapped_self)
 
     def __call__(self, *args, **kwargs):
         return super().__call__(
@@ -120,6 +124,5 @@ def wrap_entity_mem_func(wrapper):
 
     return CachedProperty(
         lambda self: EntityMemFuncWrapper(self, wrapper),
-        doc=wrapper.__doc__,
-        unbound=True
+        doc=wrapper.__doc__
     )

src/core/modules/core/core_cache.cpp

@@ -191,10 +191,16 @@ str CCachedProperty::get_name()
 	return m_name;
 }
 
+object CCachedProperty::get_owner()
+{
+	return m_owner();
+}
+
 
 void CCachedProperty::__set_name__(object owner, str name)
 {
 	m_name = name;
+	m_owner = object(handle<>(PyWeakref_NewRef(owner.ptr(), NULL)));
 }
 
 object CCachedProperty::__get__(object self, object instance, object owner=object())
@@ -302,13 +308,14 @@ void CCachedProperty::__setitem__(str item, object value)
 }
 
 
-CCachedProperty *CCachedProperty::wrap_descriptor(object descriptor, object owner=object(), str name=str())
+CCachedProperty *CCachedProperty::wrap_descriptor(
+	object descriptor, object owner=object(), str name=str(), bool unbound=false)
 {
 	CCachedProperty *pProperty = new CCachedProperty(
-		descriptor.attr("__get__"), descriptor.attr("__set__"), descriptor.attr("__delete__")
+		descriptor.attr("__get__"), descriptor.attr("__set__"), descriptor.attr("__delete__"),
+		extract<const char *>(descriptor.attr("__doc__")), unbound
 	);
 
-	pProperty->m_szDocString = extract<const char *>(descriptor.attr("__doc__"));
 	pProperty->__set_name__(owner, name);
 
 	return pProperty;

src/core/modules/core/core_cache.h

@@ -61,6 +61,7 @@ class CCachedProperty
 	object set_deleter(object fget);
 
 	str get_name();
+	object get_owner();
 
 	void __set_name__(object owner, str name);
 	static object __get__(object self, object instance, object owner);
@@ -70,14 +71,15 @@ class CCachedProperty
 	object __getitem__(str item);
 	void __setitem__(str item, object value);
 
-	static CCachedProperty *wrap_descriptor(object descriptor, object owner, str name);
+	static CCachedProperty *wrap_descriptor(object descriptor, object owner, str name, bool unbound);
 
 private:
 	object m_fget;
 	object m_fset;
 	object m_fdel;
 
 	str m_name;
+	object m_owner;
 
 	bool m_bUnbound;
 	dict m_cache;

src/core/modules/core/core_cache_wrap.cpp

@@ -56,7 +56,7 @@ void export_cached_property(scope _cache)
 		"CachedProperty",
 		init<object, object, object, const char *, bool, boost::python::tuple, dict>(
 			(
-				arg("fget")=object(), arg("fset")=object(), arg("fdel")=object(), arg("doc")=object(),
+				arg("self"), arg("fget")=object(), arg("fset")=object(), arg("fdel")=object(), arg("doc")=object(),
 				arg("unbound")=false, arg("args")=boost::python::tuple(), arg("kwargs")=dict()
 			),
 			"Represents a property attribute that is only"
@@ -83,10 +83,10 @@ void export_cached_property(scope _cache)
 			"	Deleter signature: self, *args, **kwargs\n"
 			":param str doc:\n"
 			"	Documentation string for this property.\n"
-			":param bool unbound\n"
+			":param bool unbound:\n"
 			"	Whether the cached objects should be independently maintained rather than bound to"
 			" the instance they belong to. The cache will be slightly slower to lookup, but this can"
-			" be required in certain cases to prevent circular references/memory leak.\n"
+			" be required for instances that do not have a `__dict__` attribute.\n"
 			":param tuple args:\n"
 			"	Extra arguments passed to the getter, setter and deleter functions.\n"
 			":param dict kwargs:\n"
@@ -111,7 +111,8 @@ void export_cached_property(scope _cache)
 		"	The function to register as getter function.\n"
 		"\n"
 		":rtype:\n"
-		"	function"
+		"	function",
+		args("self", "fget")
 	);
 
 	CachedProperty.add_property(
@@ -134,7 +135,8 @@ void export_cached_property(scope _cache)
 		"	The function to register as setter function.\n"
 		"\n"
 		":rtype:\n"
-		"	function"
+		"	function",
+		args("self", "fset")
 	);
 
 	CachedProperty.add_property(
@@ -157,7 +159,8 @@ void export_cached_property(scope _cache)
 		"	The function to register as deleter function.\n"
 		"\n"
 		":rtype:\n"
-		"	function"
+		"	function",
+		args("self", "fdel")
 	);
 
 	CachedProperty.add_property(
@@ -190,6 +193,16 @@ void export_cached_property(scope _cache)
 		"	str"
 	);
 
+	CachedProperty.add_property(
+		"owner",
+		&CCachedProperty::get_owner,
+		"The owner class this property attribute was bound to.\n"
+		"\n"
+		":rtype:\n"
+		"	type"
+	);
+
+
 	CachedProperty.def_readwrite(
 		"args",
 		&CCachedProperty::m_args,
@@ -212,30 +225,51 @@ void export_cached_property(scope _cache)
 		"__set_name__",
 		&CCachedProperty::__set_name__,
 		"Called when this property is being bound to a class.\n"
+		"\n"
+		":param class owner:\n"
+		"	The class this property is being bound to.\n"
+		":param str name:\n"
+		"	The name this property is being bound as.",
+		args("self", "owner", "name")
 	);
 
 	CachedProperty.def(
 		"__get__",
 		&CCachedProperty::__get__,
 		"Retrieves the value of this property.\n"
 		"\n"
+		":param object instance:\n"
+		"	The instance for which this property is retrieved.\n"
+		":param class owner:\n"
+		"	The class for which this property is retrieved.\n"
+		"\n"
 		":rtype:\n"
-		"	object"
+		"	object",
+		("self", "instance", arg("owner")=object())
 	);
 
 	CachedProperty.def(
 		"__set__",
 		&CCachedProperty::__set__,
 		"Assigns the value of this property.\n"
 		"\n"
+		":param object instance:\n"
+		"	The instance this property is being assigned to.\n"
+		":param object value:\n"
+		"	The value assigned to this property.\n"
 		":rtype:\n"
-		"	object"
+		"	object",
+		args("self", "instance", "value")
 	);
 
 	CachedProperty.def(
 		"__delete__",
 		&CCachedProperty::__delete__,
-		"Deletes this property and invalidates its cached value."
+		"Deletes this property and invalidates its cached value.\n"
+		"\n"
+		":param object instance:\n"
+		"	The instance for which this property if being deleted.",
+		args("self", "instance")
 	);
 
 	CachedProperty.def(
@@ -247,7 +281,8 @@ void export_cached_property(scope _cache)
 		"	The function to register as getter function.\n"
 		"\n"
 		":rtype:\n"
-		"	function"
+		"	function",
+		args("self", "fget")
 	);
 
 	CachedProperty.def(
@@ -259,7 +294,8 @@ void export_cached_property(scope _cache)
 		"	The name of the keyword.\n"
 		"\n"
 		":rtype:"
-		"	object"
+		"	object",
+		args("self", "item")
 	);
 
 	CachedProperty.def(
@@ -270,7 +306,8 @@ void export_cached_property(scope _cache)
 		":param str item:\n"
 		"	The name of the keyword.\n"
 		":param object value:\n"
-		"	The value to assign to the given keyword."
+		"	The value to assign to the given keyword.",
+		args("self", "item", "value")
 	);
 
 	CachedProperty.def(
@@ -292,7 +329,7 @@ void export_cached_property(scope _cache)
 		"	If the given descriptor doesn't have the required methods.\n"
 		":raises TypeError:\n"
 		"	If the getter, setter or deleter are not callable.",
-		("descriptor", arg("owner")=object(), arg("name")=str())
+		("descriptor", arg("owner")=object(), arg("name")=str(), arg("unbound")=false)
 	)
 	.staticmethod("wrap_descriptor");
 

src/core/utilities/wrap_macros.h

@@ -164,7 +164,7 @@ template<typename T>
 T cached_property(T cls, const char *szName)
 {
 	cls.attr(szName) = transfer_ownership_to_python(
-		CCachedProperty::wrap_descriptor(cls.attr(szName), cls, szName)
+		CCachedProperty::wrap_descriptor(cls.attr(szName), cls, szName, false)
 	);
 	return cls;
 };