Release 0.6.0

.travis.yml

@@ -11,7 +11,9 @@ matrix:
     # The pypy tests are slow, so we list them first
     - python: pypy3.5
     - language: generic
-      env: USE_PYPY_NIGHTLY=1
+      env: PYPY_NIGHTLY_BRANCH=py3.5
+    - language: generic
+      env: PYPY_NIGHTLY_BRANCH=py3.6
     - python: 3.5.0
     - python: 3.5.2
     - python: 3.6
@@ -26,6 +28,15 @@ matrix:
     - python: 3.8-dev
       dist: xenial
       sudo: required
+    # - os: osx
+    #   language: generic
+    #   env: MACPYTHON=3.5.4
+    # - os: osx
+    #   language: generic
+    #   env: MACPYTHON=3.6.6
+    # - os: osx
+    #   language: generic
+    #   env: MACPYTHON=3.7.0
 
 script:
   - ci/travis.sh

Jenkinsfile

@@ -1,7 +1,7 @@
 def configs = [
     [
         label: 'sierra',
-        pyversions: ['python3.5', 'python3.6'],
+        pyversions: ['python3.5', 'python3.6', 'python3.7'],
     ],
 ]
 
@@ -52,6 +52,7 @@ def build(pyversion, label) {
                             export PATH="/usr/local/bin:\${PATH}"
                             export PATH="/Library/Frameworks/Python.framework/Versions/3.5/bin:\${PATH}"
                             export PATH="/Library/Frameworks/Python.framework/Versions/3.6/bin:\${PATH}"
+                            export PATH="/Library/Frameworks/Python.framework/Versions/3.7/bin:\${PATH}"
 
                             # Workaround for https://github.com/pypa/pip/issues/5345
                             # See also:

appveyor.yml

@@ -8,6 +8,8 @@ environment:
     - PYTHON: "C:\\Python35-x64"
     - PYTHON: "C:\\Python36"
     - PYTHON: "C:\\Python36-x64"
+    - PYTHON: "C:\\Python37"
+    - PYTHON: "C:\\Python37-x64"
 
 build_script:
   - "git --no-pager log -n2"

ci/travis.sh

@@ -6,8 +6,20 @@ YAPF_VERSION=0.20.1
 
 git rev-parse HEAD
 
-if [ "$USE_PYPY_NIGHTLY" = "1" ]; then
-    curl -fLo pypy.tar.bz2 http://buildbot.pypy.org/nightly/py3.5/pypy-c-jit-latest-linux64.tar.bz2
+if [ "$TRAVIS_OS_NAME" = "osx" ]; then
+    curl -Lo macpython.pkg https://www.python.org/ftp/python/${MACPYTHON}/python-${MACPYTHON}-macosx10.6.pkg
+    sudo installer -pkg macpython.pkg -target /
+    ls /Library/Frameworks/Python.framework/Versions/*/bin/
+    PYTHON_EXE=/Library/Frameworks/Python.framework/Versions/*/bin/python3
+    # The pip in older MacPython releases doesn't support a new enough TLS
+    curl https://bootstrap.pypa.io/get-pip.py | sudo $PYTHON_EXE
+    sudo $PYTHON_EXE -m pip install virtualenv
+    $PYTHON_EXE -m virtualenv testenv
+    source testenv/bin/activate
+fi
+
+if [ "$PYPY_NIGHTLY_BRANCH" != "" ]; then
+    curl -fLo pypy.tar.bz2 http://buildbot.pypy.org/nightly/${PYPY_NIGHTLY_BRANCH}/pypy-c-jit-latest-linux64.tar.bz2
     if [ ! -s pypy.tar.bz2 ]; then
         # We know:
         # - curl succeeded (200 response code; -f means "exit with error if

docs/source/history.rst

@@ -5,6 +5,34 @@ Release history
 
 .. towncrier release notes start
 
+Trio 0.6.0 (2018-08-13)
+-----------------------
+
+Features
+~~~~~~~~
+
+- Add :func:`trio.hazmat.WaitForSingleObject` async function to await Windows
+  handles. (`#233 <https://github.com/python-trio/trio/issues/233>`__)
+- The `sniffio <https://github.com/python-trio/sniffio>`__ library can now
+  detect when Trio is running. (`#572
+  <https://github.com/python-trio/trio/issues/572>`__)
+
+
+Bugfixes
+~~~~~~~~
+
+- Make trio.socket._SocketType.connect *always* close the socket on
+  cancellation (`#247 <https://github.com/python-trio/trio/issues/247>`__)
+- Fix a memory leak in :class:`trio.CapacityLimiter`, that could occurr when
+  ``acquire`` or ``acquire_on_behalf_of`` was cancelled. (`#548
+  <https://github.com/python-trio/trio/issues/548>`__)
+- Some version of MacOS have a buggy ``getaddrinfo`` that was causing spurious
+  test failures; we now detect those systems and skip the relevant test when
+  found. (`#580 <https://github.com/python-trio/trio/issues/580>`__)
+- Prevent crashes when used with Sentry (raven-python). (`#599
+  <https://github.com/python-trio/trio/issues/599>`__)
+
+
 Trio 0.5.0 (2018-07-20)
 -----------------------
 

docs/source/index.rst

@@ -80,6 +80,7 @@ Vital statistics:
    design.rst
    history.rst
    contributing.rst
+   releasing.rst
    code-of-conduct.rst
 
 ====================

docs/source/reference-hazmat.rst

@@ -253,6 +253,19 @@ anything real. See `#26
 Windows-specific API
 --------------------
 
+.. function:: WaitForSingleObject(handle)
+    :async:
+
+    Async and cancellable variant of `WaitForSingleObject
+    <https://msdn.microsoft.com/en-us/library/windows/desktop/ms687032(v=vs.85).aspx>`__.
+    Windows only.
+
+    :arg handle:
+        A Win32 object handle, as a Python integer.
+    :raises OSError:
+        If the handle is invalid, e.g. when it is already closed.
+
+
 TODO: these are implemented, but are currently more of a sketch than
 anything real. See `#26
 <https://github.com/python-trio/trio/issues/26>`__ and `#52

docs/source/releasing.rst

@@ -0,0 +1,67 @@
+.. _releasing:
+
+Preparing a release
+-------------------
+
+Things to do for releasing:
+
+* announce intent to release on gitter
+
+* check for open issues / pull requests that really should be in the release
+
+   + come back when these are done
+
+   + … or ignore them and do another release next week
+
+* check for deprecations "long enough ago" (two months or two releases, whichever is longer)
+
+   + remove affected code
+
+* Do the actual release changeset
+
+   + update version number
+
+      - increment as per Semantic Versioning rules
+
+      - remove ``+dev`` tag from version number
+
+   + Run ``towncrier``
+
+      - review history change
+
+      - ``git rm`` changes
+
+   + commit
+
+* push to your personal repository, "release" branch
+
+* create pull request to ``python-trio/trio``'s "release" branch
+
+* announce PR on gitter
+
+   + wait for feedback
+
+   + fix problems, if any
+
+* verify that all checks succeeded
+
+* acknowledge the release PR
+
+   + or rather, somebody else should do that
+
+* tag with vVERSION
+
+* push to PyPI
+
+   + ``python3 setup.py sdist bdist_wheel upload``
+
+* announce on gitter
+
+* update version number
+
+   + add ``+dev`` tag to the end
+
+* prepare pull request from "release" back to "master"
+
+   + acknowledge it
+

docs/source/tutorial.rst

@@ -374,7 +374,7 @@ with :func:`time.sleep`. ``async/await`` is useless!
 
 Well, not really. Trio has one more trick up its sleeve, that makes
 async functions more powerful than regular functions: it can run
-multiple async function *at the same time*. Here's an example:
+multiple async functions *at the same time*. Here's an example:
 
 .. _tutorial-example-tasks-intro:
 

setup.py

@@ -79,6 +79,7 @@
         "async_generator >= 1.9",
         "idna",
         "outcome",
+        "sniffio",
         # PEP 508 style, but:
         # https://bitbucket.org/pypa/wheel/issues/181/bdist_wheel-silently-discards-pep-508
         #"cffi; os_name == 'nt'",  # "cffi is required on windows"

trio/__init__.py

@@ -1,3 +1,6 @@
+"""Trio - Pythonic async I/O for humans and snake people.
+"""
+
 # General layout:
 #
 # trio/_core/... is the self-contained core library. It does various

trio/_core/__init__.py

@@ -1,3 +1,10 @@
+"""
+This namespace represents the core functionality that has to be built-in
+and deal with private internal data structures. Things in this namespace
+are publicly available in either trio, trio.hazmat, or trio.testing.
+"""
+
+
 # Needs to be defined early so it can be imported:
 def _public(fn):
     # Used to mark methods on _Runner and on IOManager implementations that

trio/_core/_io_windows.py

@@ -22,6 +22,7 @@
     INVALID_HANDLE_VALUE,
     raise_winerror,
     ErrorCodes,
+    _handle,
 )
 
 # There's a lot to be said about the overall design of a Windows event
@@ -96,19 +97,6 @@ def _check(success):
     return success
 
 
-def _handle(obj):
-    # For now, represent handles as either cffi HANDLEs or as ints.  If you
-    # try to pass in a file descriptor instead, it's not going to work
-    # out. (For that msvcrt.get_osfhandle does the trick, but I don't know if
-    # we'll actually need that for anything...) For sockets this doesn't
-    # matter, Python never allocates an fd. So let's wait until we actually
-    # encounter the problem before worrying about it.
-    if type(obj) is int:
-        return ffi.cast("HANDLE", obj)
-    else:
-        return obj
-
-
 @attr.s(frozen=True)
 class _WindowsStatistics:
     tasks_waiting_overlapped = attr.ib()

trio/_core/_ki.py

@@ -77,12 +77,10 @@
 # for any Python program that's written to catch and ignore
 # KeyboardInterrupt.)
 
-
-# We use this class object as a unique key into the frame locals dictionary,
-# which in particular is guaranteed not to clash with any possible real local
-# name (I bet this will confuse some debugger at some point though...):
-class LOCALS_KEY_KI_PROTECTION_ENABLED:
-    pass
+# We use this special string as a unique key into the frame locals dictionary.
+# The @ ensures it is not a valid identifier and can't clash with any possible
+# real local name. See: https://github.com/python-trio/trio/issues/469
+LOCALS_KEY_KI_PROTECTION_ENABLED = '@TRIO_KI_PROTECTION_ENABLED'
 
 
 # NB: according to the signal.signal docs, 'frame' can be None on entry to

trio/_core/_run.py

@@ -1,18 +1,20 @@
 import functools
-import inspect
 import logging
 import os
 import random
 import select
 import threading
 from collections import deque
+import collections.abc
 from contextlib import contextmanager, closing
 
 import outcome
 from contextvars import copy_context
 from math import inf
 from time import monotonic
 
+from sniffio import current_async_library_cvar
+
 import attr
 from async_generator import (
     async_generator, yield_, asynccontextmanager, isasyncgen
@@ -745,7 +747,7 @@ def spawn_impl(self, async_fn, args, nursery, name, *, system_task=False):
         def _return_value_looks_like_wrong_library(value):
             # Returned by legacy @asyncio.coroutine functions, which includes
             # a surprising proportion of asyncio builtins.
-            if inspect.isgenerator(value):
+            if isinstance(value, collections.abc.Generator):
                 return True
             # The protocol for detecting an asyncio Future-like object
             if getattr(value, "_asyncio_future_blocking", None) is not None:
@@ -764,7 +766,7 @@ def _return_value_looks_like_wrong_library(value):
             coro = async_fn(*args)
         except TypeError:
             # Give good error for: nursery.start_soon(trio.sleep(1))
-            if inspect.iscoroutine(async_fn):
+            if isinstance(async_fn, collections.abc.Coroutine):
                 raise TypeError(
                     "trio was expecting an async function, but instead it got "
                     "a coroutine object {async_fn!r}\n"
@@ -797,7 +799,7 @@ def _return_value_looks_like_wrong_library(value):
         # for things like functools.partial objects wrapping an async
         # function. So we have to just call it and then check whether the
         # result is a coroutine object.
-        if not inspect.iscoroutine(coro):
+        if not isinstance(coro, collections.abc.Coroutine):
             # Give good error for: nursery.start_soon(func_returning_future)
             if _return_value_looks_like_wrong_library(coro):
                 raise TypeError(
@@ -874,8 +876,14 @@ def task_exited(self, task, result):
             task._cancel_stack[-1]._remove_task(task)
         self.tasks.remove(task)
         if task._parent_nursery is None:
-            # the init task should be the last task to exit
-            assert not self.tasks
+            # the init task should be the last task to exit. If not, then
+            # something is very wrong. Probably it hit some unexpected error,
+            # in which case we re-raise the error (which will later get
+            # converted to a TrioInternalError, but at least we'll get a
+            # traceback). Otherwise, raise a new error.
+            if self.tasks:  # pragma: no cover
+                result.unwrap()
+                raise TrioInternalError
         else:
             task._parent_nursery._child_finished(task, result)
         if task is self.main_task:
@@ -1235,11 +1243,13 @@ def run(
         clock = SystemClock()
     instruments = list(instruments)
     io_manager = TheIOManager()
+    system_context = copy_context()
+    system_context.run(current_async_library_cvar.set, "trio")
     runner = Runner(
         clock=clock,
         instruments=instruments,
         io_manager=io_manager,
-        system_context=copy_context(),
+        system_context=system_context,
     )
     GLOBAL_RUN_CONTEXT.runner = runner
     locals()[LOCALS_KEY_KI_PROTECTION_ENABLED] = True