check env variable DJ_ADAPTED_TYPES to switch supprt for AttributeAdapter

Author: dimitri-yatsenko

datajoint/attribute_adapter.py

@@ -1,6 +1,28 @@
 import re
+import os
 from .errors import DataJointError
 
+
+ADAPTED_TYPE_SWITCH = "DJ_SUPPORT_ADAPTED_TYPES"
+
+
+def _switch_adapated_types(on):
+    """
+    Enable (on=True) or disable (on=False) support for AttributeAdapter
+    """
+    if on:
+        os.environ[ADAPTED_TYPE_SWITCH] = "TRUE"
+    else:
+        del os.environ[ADAPTED_TYPE_SWITCH]
+
+
+def _support_adapted_types():
+    """
+    check if support for AttributeAdapter is enabled
+    """
+    return os.getenv(ADAPTED_TYPE_SWITCH, "FALSE").upper() == "TRUE"
+
+
 class AttributeAdapter:
     """
     Base class for adapter objects for user-defined attribute types.
@@ -33,6 +55,8 @@ def get_adapter(context, adapter_name):
     """
     Extract the AttributeAdapter object by its name from the context and validate.
     """
+    if not _support_adapted_types():
+        raise DataJointError('Support for Adapted Attribute types is disabled.')
     adapter_name = adapter_name.lstrip('<').rstrip('>')
     try:
         adapter = context[adapter_name]

datajoint/version.py

@@ -1 +1,3 @@
-__version__ = "0.12.dev6c"
+__version__ = "0.12.dev6"
+
+assert len(__version__) <= 10  # The log table limits version to the 10 characters

tests/schema_adapted.py

@@ -1,11 +1,15 @@
 import datajoint as dj
 import networkx as nx
+from datajoint import attribute_adapter
 
 from . import PREFIX, CONN_INFO
 
+
 schema_name = PREFIX + '_test_custom_datatype'
 schema = dj.schema(schema_name, connection=dj.conn(**CONN_INFO))
 
+attribute_adapter._switch_adapated_types(True)
+
 
 class GraphAdapter(dj.AttributeAdapter):
 
@@ -34,3 +38,6 @@ class Connectivity(dj.Manual):
     ---
     conn_graph = null : <graph>
     """
+
+
+attribute_adapter._switch_adapated_types(False)

tests/test_adapted_attributes.py

@@ -5,8 +5,12 @@
 from . import schema_adapted as adapted
 from .schema_adapted import graph
 
+from datajoint import attribute_adapter
+
+
 
 def test_adapted_type():
+    attribute_adapter._switch_adapated_types(True)
     c = adapted.Connectivity()
     graphs = [nx.lollipop_graph(4, 2), nx.star_graph(5), nx.barbell_graph(3, 1), nx.cycle_graph(5)]
     c.insert((i, g) for i, g in enumerate(graphs))
@@ -16,6 +20,7 @@ def test_adapted_type():
         assert_equal(len(g1.edges), len(g2.edges))
         assert_true(0 == len(nx.symmetric_difference(g1, g2).edges))
     c.delete()
+    attribute_adapter._switch_adapated_types(False)
 
 
 # test spawned classes
@@ -24,6 +29,7 @@ def test_adapted_type():
 
 
 def test_adapted_spawned():
+    attribute_adapter._switch_adapated_types(True)
     c = Connectivity()  # a spawned class
     graphs = [nx.lollipop_graph(4, 2), nx.star_graph(5), nx.barbell_graph(3, 1), nx.cycle_graph(5)]
     c.insert((i, g) for i, g in enumerate(graphs))
@@ -33,13 +39,15 @@ def test_adapted_spawned():
         assert_equal(len(g1.edges), len(g2.edges))
         assert_true(0 == len(nx.symmetric_difference(g1, g2).edges))
     c.delete()
+    attribute_adapter._switch_adapated_types(False)
 
 
 # test with virtual module
 virtual_module = dj.create_virtual_module('virtual_module', adapted.schema_name, add_objects={'graph': graph})
 
 
 def test_adapted_virtual():
+    attribute_adapter._switch_adapated_types(True)
     c = virtual_module.Connectivity()
     graphs = [nx.lollipop_graph(4, 2), nx.star_graph(5), nx.barbell_graph(3, 1), nx.cycle_graph(5)]
     c.insert((i, g) for i, g in enumerate(graphs))
@@ -53,3 +61,7 @@ def test_adapted_virtual():
             assert_equal(len(g1.edges), len(g2.edges))
             assert_true(0 == len(nx.symmetric_difference(g1, g2).edges))
     c.delete()
+    attribute_adapter._switch_adapated_types(False)
+
+
+