Merge pull request #11 from minddistrict/send-fieldupdatedevent

Update bootstrap.py and send FieldUpdatedEvent on __set__

.travis.yml

@@ -1,9 +1,10 @@
 language: python
 python:
     - 2.7
-    - 3.4
     - 3.5
     - 3.6
+    - 3.7
+    - 3.8
     - pypy
     - pypy3
 install:

CHANGES.rst

@@ -4,7 +4,8 @@ Changes
 3.0.2 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Add support for `FieldUpdatedEvent` in `LazyPropertyAnnotation` to
+  mirror the behavior of zope.schema.
 
 
 3.0.1 (2018-01-17)

bootstrap.py

@@ -14,151 +14,64 @@
 """Bootstrap a buildout-based project
 
 Simply run this script in a directory containing a buildout.cfg.
-The script accepts buildout command-line options, so you can
-use the -c option to specify an alternate configuration file.
 """
 
 import os
 import shutil
+import subprocess
 import sys
 import tempfile
 
-from optparse import OptionParser
 
 tmpeggs = tempfile.mkdtemp()
-
-usage = '''\
-[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
-
-Bootstraps a buildout-based project.
-
-Simply run this script in a directory containing a buildout.cfg, using the
-Python that you want bin/buildout to use.
-
-Note that by using --find-links to point to local resources, you can keep 
-this script from going over the network.
-'''
-
-parser = OptionParser(usage=usage)
-parser.add_option("-v", "--version", help="use a specific zc.buildout version")
-
-parser.add_option("-t", "--accept-buildout-test-releases",
-                  dest='accept_buildout_test_releases',
-                  action="store_true", default=False,
-                  help=("Normally, if you do not specify a --version, the "
-                        "bootstrap script and buildout gets the newest "
-                        "*final* versions of zc.buildout and its recipes and "
-                        "extensions for you.  If you use this flag, "
-                        "bootstrap and buildout will get the newest releases "
-                        "even if they are alphas or betas."))
-parser.add_option("-c", "--config-file",
-                  help=("Specify the path to the buildout configuration "
-                        "file to be used."))
-parser.add_option("-f", "--find-links",
-                  help=("Specify a URL to search for buildout releases"))
-parser.add_option("--allow-site-packages",
-                  action="store_true", default=False,
-                  help=("Let bootstrap.py use existing site packages"))
+ZCBUILDOUT = '2.11.3'
 
 
-options, args = parser.parse_args()
-
 ######################################################################
 # load/install setuptools
 
 try:
-    if options.allow_site_packages:
-        import setuptools
-        import pkg_resources
-    from urllib.request import urlopen
+    import pkg_resources
+    import setuptools  # NOQA
 except ImportError:
-    from urllib2 import urlopen
-
-ez = {}
-exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)
-
-if not options.allow_site_packages:
-    # ez_setup imports site, which adds site packages
-    # this will remove them from the path to ensure that incompatible versions 
-    # of setuptools are not in the path
-    import site
-    # inside a virtualenv, there is no 'getsitepackages'. 
-    # We can't remove these reliably
-    if hasattr(site, 'getsitepackages'):
-        for sitepackage_path in site.getsitepackages():
-            sys.path[:] = [x for x in sys.path if sitepackage_path not in x]
-
-setup_args = dict(to_dir=tmpeggs, download_delay=0)
-ez['use_setuptools'](**setup_args)
-import setuptools
-import pkg_resources
-
-# This does not (always?) update the default working set.  We will
-# do it.
-for path in sys.path:
-    if path not in pkg_resources.working_set.entries:
-        pkg_resources.working_set.add_entry(path)
+    ez = {}
+
+    try:
+        from urllib.request import urlopen
+    except ImportError:
+        from urllib2 import urlopen
+
+    exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)
+    # Do not update setuptools version that is the latest working version evar.
+    setup_args = dict(
+        to_dir=tmpeggs,
+        version='33.1.1',
+        download_delay=0)
+    ez['use_setuptools'](**setup_args)
+
+    import pkg_resources
+    # This does not (always?) update the default working set.  We will
+    # do it.
+    for path in sys.path:
+        if path not in pkg_resources.working_set.entries:
+            pkg_resources.working_set.add_entry(path)
 
 ######################################################################
 # Install buildout
 
 ws = pkg_resources.working_set
-
+requirement = '=='.join(('zc.buildout', ZCBUILDOUT))
 cmd = [sys.executable, '-c',
        'from setuptools.command.easy_install import main; main()',
-       '-mZqNxd', tmpeggs]
-
-find_links = os.environ.get(
-    'bootstrap-testing-find-links',
-    options.find_links or
-    ('http://downloads.buildout.org/'
-     if options.accept_buildout_test_releases else None)
-    )
-if find_links:
-    cmd.extend(['-f', find_links])
+       '-mZqNxd', tmpeggs, requirement]
 
 setuptools_path = ws.find(
     pkg_resources.Requirement.parse('setuptools')).location
 
-requirement = 'zc.buildout'
-version = options.version
-if version is None and not options.accept_buildout_test_releases:
-    # Figure out the most recent final version of zc.buildout.
-    import setuptools.package_index
-    _final_parts = '*final-', '*final'
-
-    def _final_version(parsed_version):
-        for part in parsed_version:
-            if (part[:1] == '*') and (part not in _final_parts):
-                return False
-        return True
-    index = setuptools.package_index.PackageIndex(
-        search_path=[setuptools_path])
-    if find_links:
-        index.add_find_links((find_links,))
-    req = pkg_resources.Requirement.parse(requirement)
-    if index.obtain(req) is not None:
-        best = []
-        bestv = None
-        for dist in index[req.project_name]:
-            distv = dist.parsed_version
-            if _final_version(distv):
-                if bestv is None or distv > bestv:
-                    best = [dist]
-                    bestv = distv
-                elif distv == bestv:
-                    best.append(dist)
-        if best:
-            best.sort()
-            version = best[-1].version
-if version:
-    requirement = '=='.join((requirement, version))
-cmd.append(requirement)
-
-import subprocess
 if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0:
     raise Exception(
-        "Failed to execute command:\n%s" % repr(cmd)[1:-1])
+        "Failed to execute command:\n%s",
+        repr(cmd)[1:-1])
 
 ######################################################################
 # Import and run buildout
@@ -167,12 +80,5 @@ def _final_version(parsed_version):
 ws.require(requirement)
 import zc.buildout.buildout
 
-if not [a for a in args if '=' not in a]:
-    args.append('bootstrap')
-
-# if -c was provided, we push it back into args for buildout' main function
-if options.config_file is not None:
-    args[0:0] = ['-c', options.config_file]
-
-zc.buildout.buildout.main(args)
+zc.buildout.buildout.main(['bootstrap'])
 shutil.rmtree(tmpeggs)

setup.py

@@ -59,8 +59,10 @@ def read(name):
         'zope.cachedescriptors',
         'zope.component',
         'zope.container',
+        'zope.event',
         'zope.interface',
         'zope.location',
+        'zope.schema',
     ],
     tests_require=tests_require,
     test_suite='grokcore.annotation.tests.test_grok.test_suite',

src/grokcore/annotation/lazy.py

@@ -16,11 +16,13 @@
 """
 
 import persistent
+from zope import event
 import zope.annotation.interfaces
 import zope.cachedescriptors.property
 
 from zope.interface import implementer
 from zope.location import Location
+from zope.schema.fieldproperty import FieldUpdatedEvent, NO_VALUE
 from zope.annotation.interfaces import IAnnotations
 from grokcore.annotation.interfaces import IAnnotationFactory
 
@@ -49,6 +51,13 @@ def __get__(self, inst, klass):
 
         return value
 
+    def queryValue(self, inst, default):
+        value = inst._load(self.__name, _marker)
+        if value is _marker:
+            field = self.__field.bind(inst)
+            value = getattr(field, 'default', _marker)
+        return value
+
     def __set__(self, inst, value):
         if not isinstance(inst, LazyAnnotation):
             raise ValueError(self.__name, 'invalid context')
@@ -57,7 +66,9 @@ def __set__(self, inst, value):
         if field.readonly:
             raise ValueError(self.__name, 'field is readonly')
         field.validate(value)
+        old_value = self.queryValue(inst, NO_VALUE)
         inst._store(self.__name, value)
+        event.notify(FieldUpdatedEvent(inst, field, old_value, value))
 
     def __getattr__(self, name):
         return getattr(self.__field, name)

src/grokcore/annotation/tests/annotation/lazy.py

@@ -94,6 +94,20 @@
   >>> grok.deleteAnnotation(ellie, ILazy)
   False
 
+  >>> from zope.event import subscribers
+  >>> from zope.schema.fieldproperty import FieldUpdatedEvent
+  >>> event_log = []
+  >>> subscribers.append(event_log.append)
+  >>> lazyannotation.lazy_attribute = u"new value"
+  >>> len(event_log)
+  1
+  >>> (str(event_log[0].old_value), str(event_log[0].new_value))
+  ('lazily waiting for a value.', 'new value')
+  >>> event_log[0].inst is lazyannotation
+  True
+  >>> event_log[0].field.__name__
+  'lazy_attribute'
+
 """
 
 import grokcore.annotation as grok
@@ -109,7 +123,8 @@ class Mammoth(grok.Model):
 class ILazy(interface.Interface):
 
     lazy_attribute = schema.TextLine(
-        title=u'So, so lazy', default=u'lazily waiting for a value.')
+        title=u'So, so lazy',
+        default=u'lazily waiting for a value.')
 
     lazy_readonly_attribute = schema.TextLine(
         title=u'So, so lazy, but readonly',