Skip to content
Snippets Groups Projects
Commit 95d4ffb9 authored by Kyle McCormick's avatar Kyle McCormick Committed by Kyle McCormick
Browse files

refactor: rm -rf import_shims/

This package is no longer used.
parent 4531e155
No related branches found
Tags release-2021-04-12-11.12
No related merge requests found
Showing
with 0 additions and 211 deletions
This is a transitional folder as we move away from modifying ``sys.path`` in django config.
See `the ADR`_ for more details.
.. _the ADR: https://github.com/edx/edx-platform/blob/master/docs/decisions/0007-sys-path-modification-removal.rst
#!/usr/bin/env bash
#
# Context: docs/decisions/0007-sys-path-modification-removal.rst
#
# Usage:
#
# ~/edx-platform> import_shims/generate_shims.sh SOURCE DESTINATION
#
# where the modules in SOURCE should recursively have shims generated in DESTINATION,
# which should be a subfolder of import_shims/.
#
# SOURCE and DESTINATION must both be relative to the root of edx-platform,
# and must not include trailing slashes.
#
# For example:
#
# ~/edx-platform> import_shims/generate_shims.sh common/djangoapps import_shims/studio
#
# will mirror the packages structure of `common/djangoapps` within `import_shims/studio`.
# One would run this if they want to mimic the effect of adding 'common/djangoapps'
# to `sys.path` within Studio.
# Shellcheck recommends using search/replace instead of sed. It's fine as is.
# shellcheck disable=SC2001
set -e
set -o pipefail
set -u
SOURCE="$1"
PYTHON_SOURCE="${SOURCE/\//.}"
DESTINATION="$2"
for path in $(find "${SOURCE}/" -name '*.py' | grep -v migrations); do
if [[ "$path" == "${SOURCE}/__init__.py" ]]; then
# Skip unnecessary root __init__.py.
continue
fi
if [[ "$path" == "lms/djangoapps/courseware/management/commands/import.py" ]]; then
# Skip this file because its name is problematic for import shim.
# We've gone to prod with this excluded, and it hasn't been a problem.
continue
fi
if [[ "$path" == "cms/djangoapps/contentstore/management/commands/import.py" ]]; then
# Also skip this file because its name is problematic for the import shim.
continue
fi
new_path=$(echo "$path" | sed "s#${SOURCE}/#${DESTINATION}/#")
new_python_path=$(echo "$path" | sed "s#/#.#g" | sed "s#.py##" | sed "s#.__init__##")
old_python_path=$(echo "$new_python_path" | sed "s#${PYTHON_SOURCE}.##")
echo "Writing ${new_path}"
mkdir -p "$(dirname "$new_path")"
{
echo '"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""'
echo "# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long"
echo
echo "from import_shims.warn import warn_deprecated_import"
echo
echo "warn_deprecated_import('${old_python_path}', '${new_python_path}')"
echo
echo "from ${new_python_path} import *"
} > "$new_path"
done
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges', 'lms.djangoapps.badges')
from lms.djangoapps.badges import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.admin', 'lms.djangoapps.badges.admin')
from lms.djangoapps.badges.admin import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.api', 'lms.djangoapps.badges.api')
from lms.djangoapps.badges.api import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.api.serializers', 'lms.djangoapps.badges.api.serializers')
from lms.djangoapps.badges.api.serializers import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.api.tests', 'lms.djangoapps.badges.api.tests')
from lms.djangoapps.badges.api.tests import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.api.urls', 'lms.djangoapps.badges.api.urls')
from lms.djangoapps.badges.api.urls import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.api.views', 'lms.djangoapps.badges.api.views')
from lms.djangoapps.badges.api.views import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.apps', 'lms.djangoapps.badges.apps')
from lms.djangoapps.badges.apps import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.backends', 'lms.djangoapps.badges.backends')
from lms.djangoapps.badges.backends import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.backends.badgr', 'lms.djangoapps.badges.backends.badgr')
from lms.djangoapps.badges.backends.badgr import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.backends.base', 'lms.djangoapps.badges.backends.base')
from lms.djangoapps.badges.backends.base import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.backends.tests', 'lms.djangoapps.badges.backends.tests')
from lms.djangoapps.badges.backends.tests import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.backends.tests.dummy_backend', 'lms.djangoapps.badges.backends.tests.dummy_backend')
from lms.djangoapps.badges.backends.tests.dummy_backend import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.backends.tests.test_badgr_backend', 'lms.djangoapps.badges.backends.tests.test_badgr_backend')
from lms.djangoapps.badges.backends.tests.test_badgr_backend import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.events', 'lms.djangoapps.badges.events')
from lms.djangoapps.badges.events import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.events.course_complete', 'lms.djangoapps.badges.events.course_complete')
from lms.djangoapps.badges.events.course_complete import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.events.course_meta', 'lms.djangoapps.badges.events.course_meta')
from lms.djangoapps.badges.events.course_meta import *
"""Deprecated import support. Auto-generated by import_shims/generate_shims.sh."""
# pylint: disable=redefined-builtin,wrong-import-position,wildcard-import,useless-suppression,line-too-long
from import_shims.warn import warn_deprecated_import
warn_deprecated_import('badges.events.tests', 'lms.djangoapps.badges.events.tests')
from lms.djangoapps.badges.events.tests import *
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment