Merge pull request #349 from edx/cdyer/python3

Introduce python 3 compatibility.

Author: Cliff Dyer

.travis.yml

@@ -4,13 +4,16 @@ branches:
     only:
       - master
 python:
-  - "2.7"
+  - "3.5"
 cache: pip
 install:
-  - pip install -r requirements.txt
-  - pip install -r django_requirements.txt
+  - pip install tox
   - pip install codecov
+env:
+  - TOX_ENV=py27
+  - TOX_ENV=py35
+  - TOX_ENV=docs
 script:
-  - make test doc quality
+  - tox -e $TOX_ENV
 after_success:
   - codecov

CHANGELOG.rst

@@ -4,8 +4,20 @@ Change history for XBlock
 
 These are notable changes in XBlock.
 
-0.4 - In Progress
------------------
+1.0 - Python 3
+--------------
+
+* Introduce Python 3 compatibility to the xblock code base.
+  This does not enable Python 2 codebases (like edx-platform) to load xblocks
+  written in Python 3, but it lays the groundwork for future migrations.
+
+0.5 - ???
+---------
+
+No notes provided.
+
+0.4
+---
 
 * Separate Fragment class out into new web-fragments package
 

Makefile

@@ -1,12 +1,13 @@
-test:
-	coverage run -m nose
-
-docs:
-	cd doc && make html
-
 quality:
 	pep8
 	script/max_pylint_violations
+	pylint --py3k xblock
 
 package:
-	python setup.py register sdist upload
+	python setup.py register sdist upload
+
+test:
+	tox -e py27,py35
+
+docs:
+	tox -e docs

django_requirements.txt

@@ -1,4 +1,4 @@
 # Install Django requirements, if we're using the optional Django-integrated
 # parts of XBlock
 Django >= 1.8, < 1.9
-django-pyfs
+django-pyfs >= 1.0.5

doc/conf.py

@@ -13,7 +13,7 @@
 
 import sys
 import os
-from path import path
+from path import Path as path
 import sys
 import mock
 
@@ -223,4 +223,4 @@
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 #texinfo_show_urls = 'footnote'
 
-exclude_patterns = ['api/*', 'links.rst']
+exclude_patterns = ['api/*', 'links.rst']

doc/requirements.txt

@@ -4,4 +4,5 @@
 lazy
 sphinx
 sphinxcontrib-napoleon==0.2.6
+sphinx_rtd_theme==0.1.9
 path.py

pylintrc

@@ -19,7 +19,7 @@ persistent=yes
 
 # List of plugins (as comma separated values of python modules names) to load,
 # usually to register additional checkers.
-load-plugins=
+load-plugins=caniusepython3.pylint_checker
 
 
 [MESSAGES CONTROL]
@@ -46,8 +46,11 @@ disable=
     star-args,
     abstract-class-not-used,
     abstract-class-little-used,
+    abstract-class-instantiated,
     no-init,
     too-many-lines,
+    no-else-return,
+    arguments-differ,
     no-self-use,
     too-many-ancestors,
     too-many-instance-attributes,
@@ -56,7 +59,9 @@ disable=
     too-many-return-statements,
     too-many-branches,
     too-many-arguments,
-    too-many-locals
+    too-many-locals,
+    duplicate-code,
+    len-as-condition,
 
 
 [REPORTS]
@@ -93,9 +98,6 @@ comment=no
 
 [BASIC]
 
-# Required attributes for module, separated by a comma
-required-attributes=
-
 # List of builtins function names that should not be used, separated by a comma
 bad-functions=map,filter,apply,input
 
@@ -147,6 +149,7 @@ no-docstring-rgx=__.*__|test_.+|setUp|tearDown
 # ones are exempt.
 docstring-min-length=-1
 
+extension-pkg-whitelist=lxml
 
 [FORMAT]
 
@@ -228,10 +231,6 @@ additional-builtins=
 
 [CLASSES]
 
-# List of interface methods to ignore, separated by a comma. This is used for
-# instance to not check methods defines in Zope's Interface base class.
-ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
-
 # List of method names used to declare (i.e. assign) instance attributes.
 defining-attr-methods=__init__,__new__,setUp
 

requirements.txt

@@ -12,13 +12,14 @@ markupsafe
 mock
 nose
 coverage
-# pinning astroid b/c it's throwing errors on 2.7.8 altho doc says it shouldn't
-astroid == 1.2.1
-pylint == 1.3.1
+astroid
+pylint
 rednose
 pep8
+caniusepython3
 diff-cover >= 0.2.1
 ddt==0.8.0
+tox
 
 # For docs
 -r doc/requirements.txt
@@ -28,6 +29,7 @@ cookiecutter
 
 # For web fragments
 web-fragments
+#git+https://github.com/edx/web-fragments.git@0.1.1#egg=web_fragments==0.1.1
 
 # Our own XBlocks
 -e .

script/max_pylint_violations

@@ -1,5 +1,5 @@
 #!/bin/bash
-DEFAULT_MAX=7
+DEFAULT_MAX=6
 
 pylint xblock | tee /tmp/pylint-xblock.log
 ERR=`grep -E "^[C|R|W|E]:" /tmp/pylint-xblock.log | wc -l`

setup.cfg

@@ -8,4 +8,4 @@ rednose=1
 
 [pep8]
 ignore=E501,E402
-exclude=doc/*
+exclude=doc/*,.tox/