[DNM] Example full Python3 branch

bindings/pydrake/common/test/deprecation_test.py

@@ -1,16 +1,29 @@
 from __future__ import print_function
 
-from pydrake.common.deprecation import DrakeDeprecationWarning
-
-import pydoc
-import unittest
 import rlcompleter
 import six
 import sys
 from types import ModuleType
+import unittest
 import warnings
 
-import pydrake
+from pydrake.common.deprecation import DrakeDeprecationWarning
+
+
+def get_completion_suffixes(namespace, prefix, max_count=1000):
+    # Gets all completions for a given namespace and prefix, stripping the
+    # prefix from the results.
+    completer = rlcompleter.Completer(namespace)
+    suffixes = []
+    for i in range(max_count):
+        candidate = completer.complete(prefix, i)
+        if candidate is None:
+            break
+        assert candidate.startswith(prefix), (prefix, candidate)
+        suffixes.append(candidate[len(prefix):])
+    else:
+        raise RuntimeError("Exceeded max count!")
+    return suffixes
 
 
 class TestDeprecation(unittest.TestCase):
@@ -72,51 +85,56 @@ def test_module_autocomplete(self):
         # Without `__dir__` being implemented, it'll only return `install` as a
         # non-private autocomplete candidate.
         import deprecation_example
-        namespace = locals()
-        completer = rlcompleter.Completer(namespace)
-        candidates = []
-        for i in range(1000):
-            candidate = completer.complete("deprecation_example.", i)
-            if candidate is None:
-                break
-            candidates.append(candidate)
-        candidates_expected = [
+        suffixes = get_completion_suffixes(
+            locals(), prefix="deprecation_example.")
+        suffixes_expected = [
             # Injection from `Completer.attr_matches`, via `get_class_members`.
-            "deprecation_example.__class__(",
-            "deprecation_example.__delattr__(",
-            "deprecation_example.__dict__",
-            "deprecation_example.__dir__(",
-            "deprecation_example.__doc__",
-            "deprecation_example.__format__(",
-            "deprecation_example.__getattr__(",
-            "deprecation_example.__getattribute__(",
-            "deprecation_example.__hash__(",
-            "deprecation_example.__init__(",
-            "deprecation_example.__module__",
-            "deprecation_example.__new__(",
-            "deprecation_example.__reduce__(",
-            "deprecation_example.__reduce_ex__(",
-            "deprecation_example.__repr__(",
-            "deprecation_example.__setattr__(",
-            "deprecation_example.__sizeof__(",
-            "deprecation_example.__str__(",
-            "deprecation_example.__subclasshook__(",
-            "deprecation_example.__weakref__",
-            "deprecation_example._install(",
+            "__class__(",
+            "__delattr__(",
+            "__dict__",
+            "__dir__(",
+            "__doc__",
+            "__format__(",
+            "__getattr__(",
+            "__getattribute__(",
+            "__hash__(",
+            "__init__(",
+            "__module__",
+            "__new__(",
+            "__reduce__(",
+            "__reduce_ex__(",
+            "__repr__(",
+            "__setattr__(",
+            "__sizeof__(",
+            "__str__(",
+            "__subclasshook__(",
+            "__weakref__",
+            "_install(",
             # Intended completions via `__all__`.
-            "deprecation_example.sub_module",
-            "deprecation_example.value",
+            "sub_module",
+            "value",
         ]
         if six.PY3:
-            candidates_expected += [
-                'deprecation_example.__ge__(',
-                'deprecation_example.__eq__(',
-                'deprecation_example.__le__(',
-                'deprecation_example.__lt__(',
-                'deprecation_example.__gt__(',
-                'deprecation_example.__ne__(',
+            suffixes_expected += [
+                "__ge__(",
+                "__eq__(",
+                "__le__(",
+                "__lt__(",
+                "__gt__(",
+                "__ne__(",
             ]
-        self.assertSetEqual(set(candidates), set(candidates_expected))
+            if hasattr(deprecation_example, "__init_subclass__"):
+                suffixes_expected.append("__init_subclass__(")
+            # For Bionic Python3, the behavior of autocompletion seems to
+            # constrain behavior depending on underscore prefixes.
+            if "__init__(" not in suffixes:
+                under = get_completion_suffixes(
+                    locals(), prefix="deprecation_example._")
+                suffixes += ["_" + s for s in under]
+                dunder = get_completion_suffixes(
+                    locals(), prefix="deprecation_example.__")
+                suffixes += ["__" + s for s in dunder]
+        self.assertSetEqual(set(suffixes), set(suffixes_expected))
 
     def _check_warning(
             self, item, message_expected, type=DrakeDeprecationWarning):
@@ -199,11 +217,8 @@ def base_deprecation():
                 method_extra = ExampleClass.deprecated_method
                 prop = ExampleClass.deprecated_prop
                 prop_extra = ExampleClass.deprecated_prop
-            # N.B. `help(<module>)` is super verbose.
-            print("Help text:\n{}".format(
-                pydoc.getdoc(pydrake.common.deprecation)))
             # Manually set this back to `once`.
-            warnings.simplefilter("ignored", DeprecationWarning)
+            warnings.simplefilter("ignore", DeprecationWarning)
             warnings.simplefilter("once", DrakeDeprecationWarning)
 
     def test_deprecation_pybind(self):

tmp/.gitignore

@@ -0,0 +1 @@
+virtualenv*/

tmp/py3.README.md

@@ -0,0 +1,31 @@
+This is an experimental branch that uses Python3. This is not yet
+a supported configuration on Drake's `master`.
+
+As such, if you have any questions, please ask me (Eric), as other people on
+slack aren't using this code.
+
+## Setup
+
+Follow setup instructions, make sure you run `install_prereqs`.
+
+    https://drake.mit.edu/from_source.html
+
+### Bionic
+
+Follow installation instructions normally.
+
+### Xenial `virtualenv`
+
+In any terminal that you're using:
+
+    cd drake
+    source tmp/py3.virtualenv.sh
+
+Update `gen/environment.bzl` to use this Python binary:
+
+    build --python_path=<PYTHON>
+    build --action_env=DRAKE_PYTHON_BIN_PATH=<PYTHON>
+
+## Python3
+
+When building, running, or testing, pass `--config=python3`.

tmp/py3.failing_tests.txt

@@ -0,0 +1,18 @@
+source py3_setup.sh
+
+bazel-py3 test //bindings/pydrake/...
+--trace=user -f
+
+Python2
+
+Python3
+
+
+In Bionic Docker:
+
++ all_install_test.py
+    from drake import lcmt_viewer_load_robot
+ImportError: cannot import name 'lcmt_viewer_load_robot'
+
+Seems like just a sandboxing issue, as this is unreproducible from using
+sandbox install.

tmp/py3.requirements.txt

@@ -0,0 +1,9 @@
+pyyaml
+protobuf==3.6.0
+sphinx==1.8.1
+sphinx_rtd_theme
+numpy==1.14.0
+zmq
+tornado
+matplotlib
+pydot

tmp/py3.virtualenv.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+_env_dir=$(cd $(dirname ${BASH_SOURCE}) && pwd)/virtualenv
+if [[ ! -f ${_env_dir}/bin/python3 ]]; then
+(
+    set -eux
+    cd $(dirname ${_env_dir})
+    python3_bin=$(which python3)
+    ${python3_bin} -m virtualenv --python ${python3_bin} ${_env_dir}
+    set +eux
+    source ${_env_dir}/bin/activate
+    # Install some (if not all) needed dependencies.
+    pip install -r ${_env_dir}/../py3.requirements.txt
+    set -eux
+    # Reflect system Python; make `python` and `python-config` fall through to
+    # system, and use `python{major}-config`.
+    rm ${_env_dir}/bin/python
+    mv ${_env_dir}/bin/{python-config,python3-config}
+    sed -i 's#/bin/python\b#/bin/python3#g' ${_env_dir}/bin/python3-config
+)
+fi
+
+source ${_env_dir}/bin/activate
+unset _env_dir

tmp/scratch.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -eux -o pipefail
+
+# See: 
+user=$(logname)
+logname
+sudo -u ${user} touch tmp_file