Merge pull request #36 from edx/azarembok/django2

PROD-1074: Upgrade to django 2.2.

Author: azarembok

.travis.yml

@@ -5,13 +5,29 @@ language: python
 matrix:
   include:
     - python: 2.7
-      env: TOXENV=py27
+      env: TOXENV=py27-django111
+    - python: 3.5
+      env: TOXENV=py35-django111
+    - python: 3.5
+      env: TOXENV=py35-django111
+    - python: 3.5
+      env: TOXENV=py35-django20
+    - python: 3.5
+      env: TOXENV=py35-django21
+    - python: 3.5
+      env: TOXENV=py35-django22
+    - python: 3.5
+      env: TOXENV=quality
+    - python: 3.5
+      env: TOXENV=docs
     - python: 3.6
-      env: TOXENV=py36
+      env: TOXENV=py36-django111
     - python: 3.6
-      env: TOXENV=quality
+      env: TOXENV=py36-django20
     - python: 3.6
-      env: TOXENV=docs
+      env: TOXENV=py36-django21
+    - python: 3.6
+      env: TOXENV=py36-django22
 
 cache:
   - pip

Makefile

@@ -48,6 +48,9 @@ upgrade: ## update the requirements/*.txt files with the latest packages satisfy
 	pip-compile --upgrade -o requirements/quality.txt requirements/quality.in
 	pip-compile --upgrade -o requirements/travis.txt requirements/travis.in
 	pip-compile --upgrade -o requirements/dev.txt requirements/dev.in
+	# Let tox control the Django version for tests
+	sed '/^[dD]jango==/d' requirements/test.txt > requirements/test.tmp
+	mv requirements/test.tmp requirements/test.txt
 
 quality: ## check coding style with pycodestyle and pylint
 	tox -e quality

code_annotations/__init__.py

@@ -4,4 +4,4 @@
 
 from __future__ import absolute_import, unicode_literals
 
-__version__ = '0.3.2'
+__version__ = '0.3.3'

code_annotations/base.py

@@ -130,6 +130,15 @@ def _add_annotation_token(self, token):
         self.annotation_tokens.append(token)
 
     def _configure_coverage(self, coverage_target):
+        """
+        Set coverage_target to the specified value.
+
+        Args:
+            coverage_target:
+
+        Returns:
+
+        """
         if coverage_target:
             try:
                 self.coverage_target = float(coverage_target)
@@ -339,7 +348,7 @@ def _check_results_choices(self, annotation):
         """
         # Not a choice type of annotation, nothing to do
         if annotation['annotation_token'] not in self.config.choices:
-            return
+            return None
 
         token = annotation['annotation_token']
         found_valid_choices = []
@@ -366,6 +375,7 @@ def _check_results_choices(self, annotation):
                 annotation,
                 'No choices found for "{}". Expected one of {}.'.format(token, self.config.choices[token])
             )
+        return None
 
     def _get_group_children(self):
         """
@@ -394,6 +404,7 @@ def _get_group_for_token(self, token):
         for group in self.config.groups:
             if token in self.config.groups[group]:
                 return group
+        return None
 
     def check_results(self, all_results):
         """
@@ -452,7 +463,7 @@ def check_results(self, all_results):
                     if token in group_children:
                         current_group = self._get_group_for_token(token)
 
-                        if current_group is None:  # pragma: no cover
+                        if not current_group:  # pragma: no cover
                             # If we get here there is a problem with check_results' group_children not matching up with
                             # our config's groups. That puts us in an unknown state, so we should quit.
                             raise Exception(
@@ -473,7 +484,7 @@ def check_results(self, all_results):
             if current_group:
                 self.errors.append('File finished with an incomplete group {}!'.format(current_group))
 
-        return False if self.errors else True
+        return not self.errors
 
     def _add_annotation_error(self, annotation, message):
         """
@@ -506,7 +517,6 @@ def search(self):
         Returns:
             Dict of {filename: annotations} for all files with found annotations.
         """
-        pass  # pragma: no cover
 
     def _format_results_for_report(self, all_results):
         """

code_annotations/cli.py

@@ -2,6 +2,7 @@
 Command line interface for code annotation tools.
 """
 import datetime
+import sys
 import traceback
 
 import click
@@ -18,7 +19,6 @@ def entry_point():
     """
     Top level click command for the code annotation tools.
     """
-    pass
 
 
 @entry_point.command('django_find_annotations')
@@ -88,13 +88,13 @@ def django_find_annotations(
                     click.secho("---------------------------------", fg="red")
                     click.echo("\n".join(searcher.errors))
                     # If there are any errors, do not continue
-                    exit(-1)
+                    sys.exit(1)
                 click.echo("Linting passed without errors.")
 
             if coverage:
                 if not searcher.check_coverage():
                     # If there are any errors, do not continue
-                    exit(-1)
+                    sys.exit(1)
 
                 click.echo("Coverage passed without errors.")
 
@@ -153,7 +153,7 @@ def static_find_annotations(config_file, source_path, report_path, verbosity, li
                 click.secho("{} errors:".format(len(searcher.errors)), fg="red")
                 click.secho("---------------------------------", fg="red")
                 click.echo("\n".join(searcher.errors))
-                exit(-1)
+                sys.exit(1)
             click.echo("Linting passed without errors.")
 
         if report:

code_annotations/exceptions.py

@@ -7,5 +7,3 @@ class ConfigurationException(Exception):
     """
     Exception specific to code annotation configuration problems.
     """
-
-    pass

code_annotations/find_django.py

@@ -7,7 +7,6 @@
 import re
 import sys
 
-# pylint: disable=ungrouped-imports
 import django
 import yaml
 from django.apps import apps

code_annotations/generate_docs.py

@@ -49,6 +49,16 @@ def __init__(self, config, report_files):
                 self.group_mapping[token] = group_name
 
     def _add_report_file_to_full_report(self, report_file, report):
+        """
+        Add a specified report file to a report.
+
+        Args:
+            report_file:
+            report:
+
+        Returns:
+
+        """
         loaded_report = yaml.safe_load(report_file)
 
         for filename in loaded_report:

code_annotations/helpers.py

@@ -15,7 +15,7 @@ def fail(msg):
         msg: Message to log
     """
     click.secho(msg, fg="red")
-    sys.exit(-1)
+    sys.exit(1)
 
 
 class VerboseEcho(object):

pylintrc

@@ -26,17 +26,28 @@
 # 1. Edit the pylintrc file in the edx-lint repo at
 #    https://github.com/edx/edx-lint/blob/master/edx_lint/files/pylintrc
 #
-# 2. Make a new version of edx_lint, which involves the usual steps of
-#    incrementing the version number, submitting and reviewing a pull
-#    request, and updating the edx-lint version reference in this repo.
+# 2. install the updated version of edx-lint (in edx-lint):
 #
-# 3. Install the newer version of edx-lint.
+#       $ pip install .
 #
-# 4. Run:
+# 3. Run (in edx-lint):
 #
+#       # uses pylintrc_tweaks from edx-lint for linting in edx-lint
+#       # NOTE: Use Python 3.x, which no longer includes comments in the output file
 #       $ edx_lint write pylintrc
 #
-# 5. This will modify the local file.  Submit a pull request to get it
+# 4. Make a new version of edx_lint, submit and review a pull request with the
+#    pylintrc update, and after merging, update the edx-lint version by
+#    creating a new tag in the repo (uses pbr).
+#
+# 5. In your local repo, install the newer version of edx-lint.
+#
+# 6. Run:
+#
+#       # uses local pylintrc_tweaks
+#       $ edx_lint write pylintrc
+#
+# 7. This will modify the local file.  Submit a pull request to get it
 #    checked in so that others will benefit.
 #
 #
@@ -53,9 +64,9 @@
 #
 # ------------------------------
 [MASTER]
-ignore = migrations
+ignore = ,migrations, settings, wsgi.py
 persistent = yes
-load-plugins = caniusepython3.pylint_checker,edx_lint.pylint,pylint_django,pylint_celery
+load-plugins = edx_lint.pylint,pylint_django,pylint_celery
 
 [MESSAGES CONTROL]
 enable = 
@@ -248,7 +259,6 @@ enable =
 	too-many-statements,
 	too-many-boolean-expressions,
 
-	ungrouped-imports,
 	wrong-import-order,
 	wrong-import-position,
 	wildcard-import,
@@ -289,11 +299,13 @@ disable =
 	dict-view-method,
 	duplicate-code,
 	execfile-builtin,
+	feature-toggle-needs-doc,
 	file-builtin,
 	filter-builtin-not-iterating,
 	fixme,
 	getslice-method,
 	hex-method,
+	illegal-waffle-usage,
 	import-star-module-level,
 	indexing-exception,
 	input-builtin,
@@ -335,12 +347,13 @@ disable =
 	too-many-locals,
 	too-many-public-methods,
 	too-many-return-statements,
+	ungrouped-imports,
 	unichr-builtin,
 	unicode-builtin,
 	unpacking-in-except,
 	using-cmp-argument,
 	xrange-builtin,
-	zip-builtin-not-iterating,
+	zip-builtin-not-iterating,,invalid-name,useless-object-inheritance
 
 [REPORTS]
 output-format = text
@@ -351,7 +364,7 @@ evaluation = 10.0 - ((float(5 * error + warning + refactor + convention) / state
 [BASIC]
 bad-functions = map,filter,apply,input
 module-rgx = (([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-const-rgx = (([A-Z_][A-Z0-9_]*)|(__.*__)|log|urlpatterns)$
+const-rgx = (([A-Z_][A-Z0-9_]*)|(__.*__)|log|urlpatterns|logger|User)$
 class-rgx = [A-Z_][a-zA-Z0-9]+$
 function-rgx = ([a-z_][a-z0-9_]{2,40}|test_[a-z0-9_]+)$
 method-rgx = ([a-z_][a-z0-9_]{2,40}|setUp|set[Uu]pClass|tearDown|tear[Dd]ownClass|assert[A-Z]\w*|maxDiff|test_[a-z0-9_]+)$
@@ -367,7 +380,7 @@ docstring-min-length = 5
 
 [FORMAT]
 max-line-length = 120
-ignore-long-lines = ^\s*(# )?<?https?://\S+>?$
+ignore-long-lines = ^\s*(# )?((<?https?://\S+>?)|(\.\. \w+: .*))$
 single-line-if-stmt = no
 no-space-check = trailing-comma,dict-separator
 max-module-lines = 1000
@@ -440,4 +453,4 @@ int-import-graph =
 [EXCEPTIONS]
 overgeneral-exceptions = Exception
 
-# 6221f5507b1554d42ba7e841083736b0e7ebed77
+# 2baa8e2454b99e258f3d547e787ce30ef4557e22