Disable pylint errors in lms/envs/

lms/envs/acceptance.py

@@ -3,6 +3,10 @@ This config file extends the test environment configuration
 so that we can run the lettuce acceptance tests.
 """
 
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order, wrong-import-position
+
 # We intentionally define lots of variables that aren't used, and
 # want to import all variables from base settings files
 # pylint: disable=wildcard-import, unused-wildcard-import
@@ -172,7 +176,7 @@ SELENIUM_GRID = {
 #####################################################################
 # See if the developer has any local overrides.
 try:
-    from .private import *  # pylint: disable=import-error
+    from .private import *
 except ImportError:
     pass
 

lms/envs/acceptance_docker.py

@@ -3,6 +3,10 @@ This config file extends the test environment configuration
 so that we can run the lettuce acceptance tests.
 """
 
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-position
+
 # We intentionally define lots of variables that aren't used, and
 # want to import all variables from base settings files
 # pylint: disable=wildcard-import, unused-wildcard-import

lms/envs/analytics_exporter.py

 """
 This is the settings file used during execution of the analytics-exporter job.
 """
+
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import, unused-wildcard-import
+
 from .aws import *
 
 ENABLE_COMPREHENSIVE_THEMING = False

lms/envs/bok_choy.py

@@ -10,6 +10,14 @@ support both generating static assets to a directory and also serving static
 from the same directory.
 """
 
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order, wrong-import-position
+
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import
+
 import os
 from path import Path as path
 from tempfile import mkdtemp
@@ -239,6 +247,6 @@ WAFFLE_OVERRIDE = True
 #####################################################################
 # Lastly, see if the developer has any local overrides.
 try:
-    from .private import *      # pylint: disable=import-error
+    from .private import *
 except ImportError:
     pass

lms/envs/bok_choy_docker.py

@@ -3,8 +3,12 @@
 Settings for Bok Choy tests that are used when running Studio in Docker-based devstack.
 """
 
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import, unused-wildcard-import
+
 # noinspection PyUnresolvedReferences
-from .bok_choy import *  # pylint: disable=wildcard-import
+from .bok_choy import *
 
 CMS_BASE = '{}:{}'.format(os.environ['BOK_CHOY_HOSTNAME'], os.environ['BOK_CHOY_CMS_PORT'])
 LMS_BASE = '{}:{}'.format(os.environ['BOK_CHOY_HOSTNAME'], os.environ['BOK_CHOY_LMS_PORT'])

lms/envs/common.py

@@ -20,6 +20,10 @@ Longer TODO:
    multiple sites, but we do need a way to map their data assets.
 """
 
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order, wrong-import-position, ungrouped-imports
+
 # We intentionally define lots of variables that aren't used, and
 # want to import all variables from base settings files
 # pylint: disable=wildcard-import, unused-import, unused-wildcard-import

lms/envs/dev.py

@@ -8,6 +8,10 @@ sessions. Assumes structure:
         /log  # Where we're going to write log files
 """
 
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order
+
 # We intentionally define lots of variables that aren't used, and
 # want to import all variables from base settings files
 # pylint: disable=wildcard-import, unused-wildcard-import
@@ -267,7 +271,7 @@ REGISTRATION_CODE_LENGTH = 8
 #####################################################################
 # Lastly, see if the developer has any local overrides.
 try:
-    from .private import *      # pylint: disable=import-error
+    from .private import *
 except ImportError:
     pass
 

lms/envs/devstack.py

 """
 Specific overrides to the base prod settings to make development easier.
 """
+
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order, wrong-import-position
+
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import, unused-wildcard-import
+
 from os.path import abspath, dirname, join
 
-from .aws import *  # pylint: disable=wildcard-import, unused-wildcard-import
+from .aws import *
 
 # Don't use S3 in devstack, fall back to filesystem
 del DEFAULT_FILE_STORAGE

lms/envs/devstack_docker.py

-""" Overrides for Docker-based devstack. """
+"""
+Overrides for Docker-based devstack.
+"""
 
-from .devstack import *  # pylint: disable=wildcard-import, unused-wildcard-import
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import, unused-wildcard-import
+
+from .devstack import *
 
 # Docker does not support the syslog socket at /dev/log. Rely on the console.
 LOGGING['handlers']['local'] = LOGGING['handlers']['tracking'] = {

lms/envs/devstack_optimized.py

@@ -18,14 +18,18 @@ as they are for non-optimized devstack. Instead, update_assets must be
 invoked each time that changes have been made.
 """
 
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import, unused-wildcard-import
+
 import os
 
 ########################## Devstack settings ###################################
 
 if 'BOK_CHOY_HOSTNAME' in os.environ:
-    from .devstack_docker import *  # pylint: disable=wildcard-import, unused-wildcard-import
+    from .devstack_docker import *
 else:
-    from .devstack import *  # pylint: disable=wildcard-import, unused-wildcard-import
+    from .devstack import *
 
 TEST_ROOT = REPO_ROOT / "test_root"
 

lms/envs/devstack_with_worker.py

@@ -11,11 +11,12 @@ In two separate processes on devstack:
     ./manage.py lms celery worker --settings=devstack_with_worker
 """
 
-import os
-
 # We intentionally define lots of variables that aren't used, and
 # want to import all variables from base settings files
 # pylint: disable=wildcard-import, unused-wildcard-import
+
+import os
+
 if 'BOK_CHOY_HOSTNAME' in os.environ:
     from lms.envs.devstack_docker import *
 else:

lms/envs/openstack.py

@@ -2,9 +2,13 @@
 Settings for OpenStack deployments.
 """
 
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import, unused-wildcard-import
+
 # We import the aws settings because that's currently where the base settings are stored for all deployments.
 # TODO - fix this when aws.py is split/renamed.
-from .aws import *  # pylint: disable=wildcard-import, unused-wildcard-import
+from .aws import *
 
 SWIFT_AUTH_URL = AUTH_TOKENS.get('SWIFT_AUTH_URL')
 SWIFT_AUTH_VERSION = AUTH_TOKENS.get('SWIFT_AUTH_VERSION', 1)

lms/envs/sauce.py

@@ -3,6 +3,10 @@ This config file extends the test environment configuration
 so that we can run the lettuce acceptance tests on SauceLabs.
 """
 
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order
+
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
 import os
 

lms/envs/static.py

@@ -8,6 +8,10 @@ sessions. Assumes structure:
         /log  # Where we're going to write log files
 """
 
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order
+
 # We intentionally define lots of variables that aren't used, and
 # want to import all variables from base settings files
 # pylint: disable=wildcard-import, unused-wildcard-import

lms/envs/test.py

@@ -9,15 +9,14 @@ sessions. Assumes structure:
         /log  # Where we're going to write log files
 """
 
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order, wrong-import-position, ungrouped-imports
+
 # We intentionally define lots of variables that aren't used, and
 # want to import all variables from base settings files
 # pylint: disable=wildcard-import, unused-wildcard-import
 
-# Pylint gets confused by path.py instances, which report themselves as class
-# objects. As a result, pylint applies the wrong regex in validating names,
-# and throws spurious errors. Therefore, we disable invalid-name checking.
-# pylint: disable=invalid-name
-
 from .common import *
 import os
 from path import Path as path

lms/envs/test_static_optimized.py

@@ -10,6 +10,10 @@ support both generating static assets to a directory and also serving static
 from the same directory.
 """
 
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order
+
 # Start with the common settings
 from .common import *  # pylint: disable=wildcard-import, unused-wildcard-import
 from openedx.core.lib.derived import derive_settings

lms/envs/test_with_mysql.py

 """
 Used when testing with MySQL.
 """
-from .test import *  # pylint: disable=wildcard-import
-from .aws import *  # pylint: disable=wildcard-import
+
+# We intentionally define lots of variables that aren't used, and
+# want to import all variables from base settings files
+# pylint: disable=wildcard-import, unused-wildcard-import
+
+from .test import *
+from .aws import *
 
 # Dummy secret key for dev
 SECRET_KEY = 'dev key'

lms/envs/yaml_config.py

@@ -9,6 +9,11 @@ defined in the environment:
     * CONFIG_ROOT - the directory where the application
                     yaml config files are located
 """
+
+# For Django settings files, the order of imports matters,
+# because each import can override variables in previous imports.
+# pylint: disable=wrong-import-order, ungrouped-imports
+
 # We intentionally define lots of variables that aren't used, and
 # want to import all variables from base settings files
 # pylint: disable=wildcard-import, unused-wildcard-import, undefined-variable, used-before-assignment