Commit Graph

5 Commits

Author SHA1 Message Date
Kyle McCormick
dfa60a5e92 docs: update sys.path hacks ADR & add upgrade guide
The timeline of the import_shims removal has evolved
over time; notably, we are keeping the import_shims
in Lilac in order to make any lingering old-style
import paths obvious to operators.

Update the ADR to reflect this. Also, add a table
mapping old import paths to new ones.
2021-03-08 12:49:31 -05:00
Kyle McCormick
090e10683c Rename sys_path_hacks/ to import_shims/
The old folder name is somewhat confusing, because the
folder contains shims to _compensate for the removal
of sys.path hacks_, but does not contain the sys.path
hacks themselves.

Furthermore, this import_shims/ system could also be
used for other import path changes, such as turning
the locally-installed packages in common/lib/
into regular, importable modules
(e.g. `from common.lib.xmodule import abc` instead of
`from xmodule import abc`). So, a name that is not
specific to the sys.path hacks may be better
in the medium-to-long term.

Along the same lines, we also rename SysPathHackWarning
to DeprecatedEdxPlatformImportWarning.
2020-10-30 10:20:48 -04:00
Kyle McCormick
4847a18a66 Remove sys.path modification for Studio; use sys_path_hacks instead
Also, tweak the un_sys_path.sh script.
2020-10-19 09:34:31 -04:00
Kyle McCormick
b82ac1fc16 Add sys_path_hacks/warn.py for easier modification of path warnings 2020-09-30 08:56:44 -04:00
Calen Pennington
7cbfc8de40 Add an ADR capturing sys.path removal justifications 2020-09-23 10:05:37 -04:00