Merge pull request #440 from SynBioDex/437-visitor-return-values

Fix #437: visitor return values

sbol3/attachment.py

@@ -56,7 +56,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_attachment(self)
+        return visitor.visit_attachment(self)
 
 
 def build_attachment(identity: str,

sbol3/collection.py

@@ -48,7 +48,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_collection(self)
+        return visitor.visit_collection(self)
 
 
 class Experiment(Collection):
@@ -86,7 +86,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_experiment(self)
+        return visitor.visit_experiment(self)
 
 
 Document.register_builder(SBOL_COLLECTION, Collection)

sbol3/combderiv.py

@@ -62,7 +62,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_combinatorial_derivation(self)
+        return visitor.visit_combinatorial_derivation(self)
 
 
 def build_combinatorial_derivation(identity: str,

sbol3/component.py

@@ -64,7 +64,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_component(self)
+        return visitor.visit_component(self)
 
 
 def build_component(identity: str, *, type_uri: str = SBOL_COMPONENT) -> SBOLObject:

sbol3/compref.py

@@ -53,7 +53,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_component_reference(self)
+        return visitor.visit_component_reference(self)
 
 
 def build_component_reference(identity: str, *,

sbol3/constraint.py

@@ -58,7 +58,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_constraint(self)
+        return visitor.visit_constraint(self)
 
 
 def build_constraint(identity: str, type_uri: str = SBOL_CONSTRAINT) -> SBOLObject:

sbol3/document.py

@@ -607,7 +607,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_document(self)
+        return visitor.visit_document(self)
 
     def traverse(self, func: Callable[[Identified], None]):
         """Enable a traversal of the entire object hierarchy contained

sbol3/expdata.py

@@ -38,7 +38,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_experimental_data(self)
+        return visitor.visit_experimental_data(self)
 
 
 Document.register_builder(SBOL_EXPERIMENTAL_DATA, ExperimentalData)

sbol3/extdef.py

@@ -55,7 +55,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_externally_defined(self)
+        return visitor.visit_externally_defined(self)
 
 
 def build_externally_defined(identity: str,

sbol3/implementation.py

@@ -45,7 +45,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_implementation(self)
+        return visitor.visit_implementation(self)
 
 
 Document.register_builder(SBOL_IMPLEMENTATION, Implementation)

sbol3/interaction.py

@@ -50,7 +50,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_interaction(self)
+        return visitor.visit_interaction(self)
 
 
 def build_interaction(identity: str, *, type_uri: str = SBOL_INTERACTION) -> SBOLObject:

sbol3/interface.py

@@ -41,7 +41,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_interface(self)
+        return visitor.visit_interface(self)
 
 
 def build_interface(identity: str, *, type_uri: str = SBOL_INTERFACE) -> SBOLObject:

sbol3/localsub.py

@@ -47,7 +47,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_local_sub_component(self)
+        return visitor.visit_local_sub_component(self)
 
 
 def build_local_subcomponent(identity: str,

sbol3/location.py

@@ -83,7 +83,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_range(self)
+        return visitor.visit_range(self)
 
 
 def build_range(identity: str, type_uri: str = SBOL_RANGE):
@@ -138,7 +138,7 @@ def accept(self, visitor: Any) -> Any:
         :return: Whatever `visitor.visit_cut` returns
         :rtype: Any
         """
-        visitor.visit_cut(self)
+        return visitor.visit_cut(self)
 
 
 def build_cut(identity: str, type_uri: str = SBOL_CUT):
@@ -184,7 +184,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_entire_sequence(self)
+        return visitor.visit_entire_sequence(self)
 
 
 def build_entire_sequence(identity: str, type_uri: str = SBOL_ENTIRE_SEQUENCE):

sbol3/model.py

@@ -62,7 +62,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_model(self)
+        return visitor.visit_model(self)
 
 
 def build_model(identity: str, type_uri: str = SBOL_MODEL):

sbol3/om_compound.py

@@ -82,7 +82,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_unit_multiplication(self)
+        return visitor.visit_unit_multiplication(self)
 
 
 def build_unit_multiplication(identity: str,
@@ -145,7 +145,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_unit_division(self)
+        return visitor.visit_unit_division(self)
 
 
 def build_unit_division(identity: str,
@@ -209,7 +209,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_unit_exponentiation(self)
+        return visitor.visit_unit_exponentiation(self)
 
 
 def build_unit_exponentiation(identity: str,

sbol3/om_prefix.py

@@ -103,7 +103,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_si_prefix(self)
+        return visitor.visit_si_prefix(self)
 
 
 def build_si_prefix(identity: str, *, type_uri: str = OM_SI_PREFIX) -> SBOLObject:
@@ -161,7 +161,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_binary_prefix(self)
+        return visitor.visit_binary_prefix(self)
 
 
 def build_binary_prefix(identity: str,

sbol3/om_unit.py

@@ -86,7 +86,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_measure(self)
+        return visitor.visit_measure(self)
 
 
 def build_measure(identity: str, *, type_uri: str = OM_MEASURE) -> SBOLObject:
@@ -149,7 +149,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_singular_unit(self)
+        return visitor.visit_singular_unit(self)
 
 
 def build_singular_unit(identity: str,
@@ -213,7 +213,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_prefixed_unit(self)
+        return visitor.visit_prefixed_unit(self)
 
 
 def build_prefixed_unit(identity: str,

sbol3/participation.py

@@ -50,7 +50,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_participation(self)
+        return visitor.visit_participation(self)
 
 
 def build_participation(identity: str,

sbol3/provenance.py

@@ -47,7 +47,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_usage(self)
+        return visitor.visit_usage(self)
 
 
 def build_usage(identity: str, *, type_uri: str = PROV_USAGE) -> SBOLObject:
@@ -93,7 +93,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_agent(self)
+        return visitor.visit_agent(self)
 
 
 Document.register_builder(PROV_AGENT, Agent)
@@ -129,7 +129,7 @@ def accept(self, visitor: Any) -> Any:
         :return: Whatever `visitor.visit_plan` returns
         :rtype: Any
         """
-        visitor.visit_plan(self)
+        return visitor.visit_plan(self)
 
 
 Document.register_builder(PROV_PLAN, Plan)
@@ -174,7 +174,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_association(self)
+        return visitor.visit_association(self)
 
 
 def build_association(identity: str,
@@ -256,7 +256,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_activity(self)
+        return visitor.visit_activity(self)
 
 
 Document.register_builder(PROV_ACTIVITY, Activity)

sbol3/seqfeat.py

@@ -38,7 +38,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_sequence_feature(self)
+        return visitor.visit_sequence_feature(self)
 
 
 def build_sequence_feature(identity: str,

sbol3/sequence.py

@@ -58,7 +58,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_sequence(self)
+        return visitor.visit_sequence(self)
 
 
 Document.register_builder(SBOL_SEQUENCE, Sequence)

sbol3/subcomponent.py

@@ -54,7 +54,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_sub_component(self)
+        return visitor.visit_sub_component(self)
 
 
 def build_subcomponent(identity: str, type_uri: str = SBOL_SUBCOMPONENT) -> Identified:

sbol3/varcomp.py

@@ -79,7 +79,7 @@ def accept(self, visitor: Any) -> Any:
         :rtype: Any
 
         """
-        visitor.visit_variable_feature(self)
+        return visitor.visit_variable_feature(self)
 
 
 def build_variable_feature(identity: str, type_uri: str = SBOL_VARIABLE_FEATURE):

test/test_visitors.py

@@ -0,0 +1,26 @@
+import unittest
+from pathlib import Path
+
+import sbol3
+
+
+class TestVisitors(unittest.TestCase):
+
+    def test_visitor_pattern(self):
+        """Test that the visitor pattern is implemented and can use return values from visit functions"""
+        class SumVisitor:
+            def visit_document(self, doc: sbol3.Document):
+                return sum(v.accept(self) for v in doc.objects)
+
+            @staticmethod
+            def visit_component(_: sbol3.Component):
+                return 1
+
+        doc = sbol3.Document()
+        doc.read(Path(__file__).parent / 'resources' / 'circuit.nt')
+        # File containing five Components and no other TopLevel objects
+        self.assertEqual(doc.accept(SumVisitor()), 5)
+
+
+if __name__ == '__main__':
+    unittest.main()