-

cool-RR · cool-RR · commit 90d80486acdc · 2015-06-06T23:05:57.000+03:00
diff --git a/source_py3/python_toolbox/caching/cached_property.py b/source_py3/python_toolbox/caching/cached_property.py
@@ -53,15 +53,15 @@ def __init__(self, getter_or_value, doc=None, name=None,
         self.__doc__ = doc or getattr(self.getter, '__doc__', None)
         
         
-    def __get__(self, obj, our_type=None):
+    def __get__(self, thing, our_type=None):
 
-        if obj is None:
+        if thing is None:
             # We're being accessed from the class itself, not from an object
             return self
         
-        value = self.getter(obj)
+        value = self.getter(thing)
         
-        setattr(obj, self.get_our_name(obj, our_type=our_type), value)
+        setattr(thing, self.get_our_name(thing, our_type=our_type), value)
         
         return value
 
diff --git a/source_py3/python_toolbox/change_tracker.py b/source_py3/python_toolbox/change_tracker.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `ChangeTracker` class.
-
-See its documentation for more information.
-'''
-
 import pickle
 
 from python_toolbox.nifty_collections import WeakKeyIdentityDict
diff --git a/source_py3/python_toolbox/context_management/blank_context_manager.py b/source_py3/python_toolbox/context_management/blank_context_manager.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `BlankContextManager` class.
-
-See its documentation for more information.
-'''
-
 from .context_manager import ContextManager
 
 
diff --git a/source_py3/python_toolbox/context_management/context_manager.py b/source_py3/python_toolbox/context_management/context_manager.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `ContextManager` class.
-
-See its documentation for more information.
-'''
-
 import sys
 import types
 import abc
diff --git a/source_py3/python_toolbox/context_management/context_manager_type.py b/source_py3/python_toolbox/context_management/context_manager_type.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `ContextManagerType` class.
-
-See its documentation for more information.
-'''
-
 import abc
 
 from .context_manager_type_type import ContextManagerTypeType
diff --git a/source_py3/python_toolbox/context_management/context_manager_type_type.py b/source_py3/python_toolbox/context_management/context_manager_type_type.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `ContextManagerTypeType` metaclass.
-
-See its documentation for more information.
-'''
-
 
 class ContextManagerTypeType(type):
     '''
diff --git a/source_py3/python_toolbox/context_management/functions.py b/source_py3/python_toolbox/context_management/functions.py
@@ -2,7 +2,7 @@
 # This program is distributed under the MIT license.
 
 '''
-This module defines various functions.
+This module defines various functions related to context managers.
 
 See their documentation for more information.
 '''
diff --git a/source_py3/python_toolbox/context_management/self_hook.py b/source_py3/python_toolbox/context_management/self_hook.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `SelfHook` class.
-
-See its documentation for more information.
-'''
-
 class SelfHook:
     '''
     Hook that a context manager can yield in order to yield itself.
diff --git a/source_py3/python_toolbox/freezing/delegatee_context_manager.py b/source_py3/python_toolbox/freezing/delegatee_context_manager.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `DelegateeContextManager` class.
-
-See its documentation for more information.
-'''
-
 from python_toolbox import context_management
 
 
diff --git a/source_py3/python_toolbox/freezing/freezer.py b/source_py3/python_toolbox/freezing/freezer.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `Freezer` class.
-
-See its documentation for more information.
-'''
-
 import abc
 
 from python_toolbox import context_management
diff --git a/source_py3/python_toolbox/freezing/freezer_property.py b/source_py3/python_toolbox/freezing/freezer_property.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `FreezerProperty` class.
-
-See its documentation for more information.
-'''
-
 
 from python_toolbox import caching
 from python_toolbox.misc_tools import do_nothing
diff --git a/source_py3/python_toolbox/identities.py b/source_py3/python_toolbox/identities.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `HasIdentity` class.
-
-See its documentation for more information.
-'''
-
 from python_toolbox import misc_tools
 from python_toolbox.persistent import CrossProcessPersistent
 
diff --git a/source_py3/python_toolbox/locking/__init__.py b/source_py3/python_toolbox/locking/__init__.py
@@ -1,10 +1,4 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This package defines a class `ReadWriteLock` in the module `read_write_lock`.
-
-See that class's documentation for more details.
-'''
-
 from .read_write_lock import ReadWriteLock
diff --git a/source_py3/python_toolbox/misc_tools/misc_tools.py b/source_py3/python_toolbox/misc_tools/misc_tools.py
@@ -153,12 +153,12 @@ def __init__(self, name=None):
         self.our_name = name
     
         
-    def get_our_name(self, obj, our_type=None):
+    def get_our_name(self, thing, our_type=None):
         if self.our_name is not None:
             return self.our_name
         
         if not our_type:
-            our_type = type(obj)
+            our_type = type(thing)
         (self.our_name,) = (name for name in dir(our_type) if
                             getattr(our_type, name, None) is self)
         
diff --git a/source_py3/python_toolbox/misc_tools/overridable_property.py b/source_py3/python_toolbox/misc_tools/overridable_property.py
@@ -0,0 +1,48 @@
+# Copyright 2009-2015 Ram Rachum.
+# This program is distributed under the MIT license.
+
+import re
+
+from .misc_tools import OwnNameDiscoveringDescriptor
+
+
+class OverridableProperty(OwnNameDiscoveringDescriptor):
+    '''
+    blocktododoc
+    '''
+    
+    def __init__(self, fget, doc=None, name=None):
+        '''
+        blocktododoc Construct the `ProxyProperty`.
+        
+        `attribute_name` is the name of the attribute that we will proxy,
+        prefixed with a dot, like '.whatever'.
+        
+        You may also refer to a nested attribute of the object rather than a
+        direct one; for example, you can do
+        `ProxyProperty('.whatever.x.height')` and it will access the `.height`
+        attribute of the `.x` attribute of `.whatever`.
+        
+        You may specify a docstring as `doc`.
+        '''
+        OwnNameDiscoveringDescriptor.__init__(name=name)
+        if not attribute_name.startswith('.'):
+            raise Exception("The `attribute_name` must start with a dot to "
+                            "make it clear it's an attribute. %s does not "
+                            "start with a dot." % repr(attribute_name))
+        self.getter = fget
+        self.__doc__ = doc
+        
+        
+    def __get__(self, thing, our_type=None):
+        if thing is None:
+            # We're being accessed from the class itself, not from an object
+            return self
+        else:
+            return self.getter(thing)
+        
+    def __set__(self, thing, value):
+        setattr(thing, self.get_our_name(thing), value)
+        
+    def __repr__(self):
+        return '<%s: %s>' % (type(self).__name__, self.our_name or self.getter)
diff --git a/source_py3/python_toolbox/misc_tools/proxy_property.py b/source_py3/python_toolbox/misc_tools/proxy_property.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `ProxyProperty` class.
-
-See its documentation for more information.
-'''
-
 import re
 
 
diff --git a/source_py3/python_toolbox/nifty_collections/lazy_tuple.py b/source_py3/python_toolbox/nifty_collections/lazy_tuple.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `LazyTuple` class.
-
-See its documentation for more information.
-'''
-
 import functools
 import threading
 import collections
diff --git a/source_py3/python_toolbox/nifty_collections/ordered_dict.py b/source_py3/python_toolbox/nifty_collections/ordered_dict.py
@@ -1,18 +1,18 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `OrderedDict` class.
-
-See its documentation for more information.
-'''
-
 from python_toolbox import comparison_tools
 
 from collections import OrderedDict as StdlibOrderedDict
 
 
 class OrderedDict(StdlibOrderedDict):
+    '''
+    A dictionary with an order.
+    
+    This is a subclass of `collections.OrderedDict` with a couple of
+    improvements.
+    '''
     
     def sort(self, key=None, reverse=False):
         '''
diff --git a/source_py3/python_toolbox/persistent/copy_modes.py b/source_py3/python_toolbox/persistent/copy_modes.py
@@ -1,12 +1,6 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `DontCopyPersistent` class.
-
-See its documentation for more information.
-'''
-
 from python_toolbox.copy_mode import CopyMode
 
 class DontCopyPersistent(CopyMode):
diff --git a/source_py3/python_toolbox/persistent/persistent.py b/source_py3/python_toolbox/persistent/persistent.py
@@ -1,23 +1,13 @@
 # Copyright 2009-2015 Ram Rachum.
 # This program is distributed under the MIT license.
 
-'''
-This module defines the `Persistent` class.
-
-See its documentation for more information.
-
-
-
-Note: This module is still experimental
-
-todo: need to raise an exception if we're getting pickled with
-an old protocol?
-
-todo: make it polite to other similar classes. Perhaps make it a metaclass?
-'''
 from .copy_modes import DontCopyPersistent
 from python_toolbox import copy_tools
 
+# todo: need to raise an exception if we're getting pickled with
+# an old protocol?
+
+# todo: make it polite to other similar classes. Perhaps make it a metaclass?
 
 __all__ = ['Persistent']
 
