Merge pull request #661 from edx/dhm/location_mapper

Location to/from locator mapping facilities

common/lib/xmodule/xmodule/modulestore/django.py

@@ -8,6 +8,7 @@ from __future__ import absolute_import
 from importlib import import_module
 
 from django.conf import settings
+from xmodule.modulestore.loc_mapper_store import LocMapperStore
 
 _MODULESTORES = {}
 
@@ -53,3 +54,18 @@ def modulestore(name='default'):
                                                           settings.MODULESTORE[name]['OPTIONS'])
 
     return _MODULESTORES[name]
+
+_loc_singleton = None
+def loc_mapper():
+    """
+    Get the loc mapper which bidirectionally maps Locations to Locators. Used like modulestore() as
+    a singleton accessor.
+    """
+    # pylint: disable=W0603
+    global _loc_singleton
+    # pylint: disable=W0212
+    if _loc_singleton is None:
+        # instantiate
+        _loc_singleton = LocMapperStore(settings.modulestore_options)
+    return _loc_singleton
+

common/lib/xmodule/xmodule/modulestore/parsers.py

@@ -19,10 +19,10 @@ def parse_url(string):
 
     Examples:
         'edx://version/0123FFFF'
-        'edx://edu.mit.eecs.6002x'
-        'edx://edu.mit.eecs.6002x/branch/published'
-        'edx://edu.mit.eecs.6002x/branch/published/version/519665f6223ebd6980884f2b/block/HW3'
-        'edx://edu.mit.eecs.6002x/branch/published/block/HW3'
+        'edx://mit.eecs.6002x'
+        'edx://mit.eecs.6002x;published'
+        'edx://mit.eecs.6002x;published/block/HW3'
+        'edx://mit.eecs.6002x;published/version/000eee12345/block/HW3'
 
     This returns None if string cannot be parsed.
 
@@ -97,11 +97,11 @@ def parse_course_id(string):
 
     Examples of valid course_ids:
 
-      'edu.mit.eecs.6002x'
-      'edu.mit.eecs.6002x/branch/published'
-      'edu.mit.eecs.6002x/block/HW3'
-      'edu.mit.eecs.6002x/branch/published/block/HW3'
-      'edu.mit.eecs.6002x/branch/published/version/519665f6223ebd6980884f2b/block/HW3'
+      'mit.eecs.6002x'
+      'mit.eecs.6002x/branch/published'
+      'mit.eecs.6002x/block/HW3'
+      'mit.eecs.6002x/branch/published/block/HW3'
+      'mit.eecs.6002x/branch/published/version/519665f6223ebd6980884f2b/block/HW3'
 
 
     Syntax:

common/lib/xmodule/xmodule/modulestore/split_mongo/split.py

@@ -10,9 +10,8 @@ from xmodule.errortracker import null_error_tracker
 from xmodule.x_module import XModuleDescriptor
 from xmodule.modulestore.locator import BlockUsageLocator, DescriptionLocator, CourseLocator, VersionTree
 from xmodule.modulestore.exceptions import InsufficientSpecificationError, VersionConflictError
-from xmodule.modulestore import inheritance
+from xmodule.modulestore import inheritance, ModuleStoreBase
 
-from .. import ModuleStoreBase
 from ..exceptions import ItemNotFoundError
 from .definition_lazy_loader import DefinitionLazyLoader
 from .caching_descriptor_system import CachingDescriptorSystem
@@ -62,14 +61,11 @@ class SplitMongoModuleStore(ModuleStoreBase):
             **kwargs
         ), db)
 
-        # TODO add caching of structures to thread_cache to prevent repeated fetches (but not index b/c
-        # it changes w/o having a change in id)
         self.course_index = self.db[collection + '.active_versions']
         self.structures = self.db[collection + '.structures']
         self.definitions = self.db[collection + '.definitions']
 
-        # ??? Code review question: those familiar w/ python threading. Should I instead
-        # use django cache? How should I expire entries?
+        # Code review question: How should I expire entries?
         # _add_cache could use a lru mechanism to control the cache size?
         self.thread_cache = threading.local()
 
@@ -1178,6 +1174,7 @@ class SplitMongoModuleStore(ModuleStoreBase):
         else:
             return DescriptionLocator(definition['_id'])
 
+
     def _block_matches(self, value, qualifiers):
         '''
         Return True or False depending on whether the value (block contents)

common/lib/xmodule/xmodule/modulestore/tests/test_split_modulestore.py

@@ -992,8 +992,8 @@ class TestInheritance(SplitModuleTest):
 # This mocks the django.modulestore() function and is intended purely to disentangle
 # the tests from django
 def modulestore():
-    def load_function(path):
-        module_path, _, name = path.rpartition('.')
+    def load_function(engine_path):
+        module_path, _, name = engine_path.rpartition('.')
         return getattr(import_module(module_path), name)
 
     if SplitModuleTest.modulestore is None: