Merge pull request #33 from datacamp/jh/protowhat-refactor

MatzHilven · web-flow · commit a014df6ba8ff · 2025-08-20T12:52:22.000+02:00
[CX-1182] protowhat refactor
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,51 @@
+version: 2.1
+
+orbs:
+  python: circleci/python@1.2
+
+jobs:
+  build-and-test:
+    docker:
+      - image: cimg/python:3.12
+    steps:
+      - checkout
+      - run:
+          name: Install packages
+          command: make install
+      - run:
+          name: Run tests
+          command: python -m pytest --cov=sheetwhat
+  publish:
+    docker:
+      - image: cimg/python:3.12
+    steps:
+      - checkout
+      - run:
+          command: |
+            python setup.py sdist bdist_wheel
+            pip install pipenv
+            pipenv install twine
+            pipenv run twine upload --verbose --repository pypi dist/*
+workflows:
+  pr:
+    jobs:
+      - build-and-test:
+          filters:
+            branches:
+              ignore: master
+  publish:
+    jobs:
+      - build-and-test:
+          filters:
+            tags:
+              only: /^v\d+\.\d+\.\d+$/
+            branches:
+              ignore: /.*/
+      - publish:
+          requires:
+            - build-and-test
+          filters:
+            tags:
+              only: /^v\d+\.\d+\.\d+$/
+            branches:
+              ignore: /.*/
diff --git a/.gitignore b/.gitignore
@@ -78,3 +78,5 @@ tests/.DS_Store
 # Custom
 .pytest_cache/*
 
+# IDE
+.idea
diff --git a/.python-version b/.python-version
@@ -1 +1 @@
-3.6.2
+3.12.11
diff --git a/.travis.yml b/.travis.yml
diff --git a/Makefile b/Makefile
@@ -0,0 +1,22 @@
+# Controls
+.PHONY : commands install clean test
+all : commands
+
+## commands : show all commands.
+commands :
+	@grep -h -E '^##' Makefile | sed -e 's/## //g'
+
+install:
+	pip3.12 install -e .
+	pip3.12 install -r requirements.txt
+
+## test     : run tests.
+test :
+	pytest --cov=sheetwhat
+
+## clean    : clean up junk files.
+clean :
+	@rm -rf bin/__pycache__
+	@find . -name .DS_Store -exec rm {} \;
+	@find . -name '*~' -exec rm {} \;
+	@find . -name '*.pyc' -exec rm {} \;
diff --git a/README.md b/README.md
@@ -3,10 +3,7 @@
 
 # sheetwhat
 
-[![Build Status](https://travis-ci.org/datacamp/sheetwhat.svg?branch=master)](https://travis-ci.org/datacamp/sheetwhat)
-[![codecov](https://codecov.io/gh/datacamp/sheetwhat/branch/master/graph/badge.svg)](https://codecov.io/gh/datacamp/sheetwhat)
 [![PyPI version](https://badge.fury.io/py/sheetwhat.svg)](https://badge.fury.io/py/sheetwhat)
-[![Documentation Status](https://readthedocs.org/projects/sheetwhat/badge/?version=latest)](https://sheetwhat.readthedocs.io/en/latest/?badge=latest)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdatacamp%2Fsheetwhat.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdatacamp%2Fsheetwhat?ref=badge_shield)
 
 `sheetwhat` enables you to write Submission Correctness Tests (SCTs) for interactive Spreadsheet exercises on DataCamp.
diff --git a/requirements.txt b/requirements.txt
@@ -1,12 +1,11 @@
 # pkg deps
-protowhat~=1.8.0
+protowhat~=2.3.1
 attrs~=18.2.0
 glom~=18.3.1
 
 # test deps
-pytest~=3.7.4
-codecov~=2.0.15
-pytest-cov~=2.5.1
+pytest~=8.1.1
+pytest-cov~=6.1.1
 
 # doc deps
 sphinx~=1.7.7
diff --git a/sheetwhat/State.py b/sheetwhat/State.py
@@ -1,9 +1,7 @@
-from protowhat.Feedback import Feedback
+from protowhat.Feedback import FeedbackComponent
 from protowhat.State import State as BaseState
 import copy
 
-from protowhat.Test import Fail
-
 from sheetwhat.selectors import Dispatcher
 
 
@@ -15,26 +13,30 @@ def __init__(
         self.solution_data = solution_data
         self.sct_range = sct_range
         self.reporter = reporter
-        self.messages = []
+        self.feedback_context = None
         self.creator = None
         self.dispatcher = Dispatcher()
         self.node_name = "root"
         self.force_diagnose = force_diagnose
-
-    def report(self, feedback: str):
-        return self.do_test(Fail(Feedback(feedback)))
+        self.debug = False
 
     def to_child(self, append_message="", node_name=None, **kwargs):
         """Basic implementation of returning a child state"""
         child = copy.deepcopy(self)
         for kwarg in kwargs:
             setattr(child, kwarg, kwargs[kwarg])
         child.node_name = node_name
-        if not isinstance(append_message, dict):
-            append_message = {"msg": append_message, "kwargs": {}}
-        child.messages = [*self.messages, append_message]
+        if not isinstance(append_message, FeedbackComponent):
+            append_message = FeedbackComponent(append_message)
+        child.feedback_context = append_message
         return child
 
+    def get_feedback(self, conclusion):
+        return self.feedback_cls(
+            conclusion,
+            [state.feedback_context for state in self.state_history],
+        )
+
     def to_message_exposed_dict(self):
         """This dictionary is passed through to the message formatter. The fields
         defined in the dictionary can be replaced by values in the state by using
diff --git a/sheetwhat/Test.py b/sheetwhat/Test.py
@@ -4,7 +4,7 @@
 
 from protowhat import selectors
 from protowhat.Test import Test
-from protowhat.Feedback import Feedback
+from protowhat.Feedback import FeedbackComponent
 
 from sheetwhat.utils import is_empty
 
@@ -16,21 +16,23 @@ def __init__(self, student_data, solution_data, feedback):
         self.solution_data = solution_data
 
     def __repr__(self):
-        return f"{self.__class__.__name__}:" \
-            f"student data = {self.student_data}" \
+        return (
+            f"{self.__class__.__name__}:"
+            f"student data = {self.student_data}"
             f"solution data = {self.solution_data}"
+        )
 
 
 def array_element_tests(test, student_data, solution_data, feedback, *args, **kwargs):
     tests = []
     if not isinstance(student_data, list) or not isinstance(solution_data, list):
-        # If student data is None; Feedback will be provided by a different test.
+        # If student data is None; FeedbackComponent will be provided by a different test.
         return tests
     for i, (element_student_data, element_solution_data) in enumerate(
         zip(student_data, solution_data)
     ):
         if isinstance(feedback, str):
-            item_feedback = Feedback(feedback)
+            item_feedback = FeedbackComponent(feedback)
         else:
             item_feedback = copy.deepcopy(feedback)
         item_feedback.message = item_feedback.message.format(
diff --git a/sheetwhat/__init__.py b/sheetwhat/__init__.py
@@ -1 +1 @@
-__version__ = "0.5.3"
+__version__ = "0.6.0"
diff --git a/sheetwhat/checks/__init__.py b/sheetwhat/checks/__init__.py
@@ -27,4 +27,4 @@
 # - no check_file related functionality
 from protowhat.checks.check_logic import fail, multi, check_not, check_or, check_correct
 from protowhat.checks.check_simple import has_chosen, success_msg
-from protowhat.utils import _debug
+from protowhat.failure import _debug
diff --git a/sheetwhat/checks/check_chart.py b/sheetwhat/checks/check_chart.py
@@ -1,5 +1,6 @@
 from functools import partial
 from protowhat import selectors
+from protowhat.Feedback import FeedbackComponent
 
 from sheetwhat.selectors import state_selector, Dispatcher
 from ..utils import range_to_row_columns, row_columns_to_range
@@ -144,12 +145,12 @@ def has_equal_series(state):
             array_element_tests(
                 EqualityTest,
                 *selector(series_path[state.node_name].get("source")),
-                state.build_message("the {ordinal} series' source is not correct."),
+                FeedbackComponent("the {ordinal} series' source is not correct."),
             )
             + array_element_tests(
                 EqualityTest,
                 *selector(series_path[state.node_name].get("color")),
-                state.build_message("the {ordinal} series' color is not correct."),
+                FeedbackComponent("the {ordinal} series' color is not correct."),
             )
         )
     return state
diff --git a/sheetwhat/sct_context.py b/sheetwhat/sct_context.py
@@ -0,0 +1,9 @@
+from protowhat.sct_context import create_sct_context, get_checks_dict
+from sheetwhat import checks
+
+SCT_DICT = get_checks_dict(checks)
+SCT_CTX = create_sct_context(SCT_DICT)
+
+# put on module for easy * importing
+globals().update(SCT_CTX)
+__all__ = list(SCT_CTX.keys())
diff --git a/sheetwhat/sct_syntax.py b/sheetwhat/sct_syntax.py
@@ -1,21 +1,4 @@
-# Wrap SCT checks -------------------------------------------------------------
+from sheetwhat.sct_context import SCT_CTX
 
-from sheetwhat.State import State
-from sheetwhat import checks
-import builtins
-from protowhat.sct_syntax import create_sct_context
-
-# used in Chain and F, to know what methods are available
-sct_dict = {
-    k: v
-    for k, v in vars(checks).items()
-    if k not in builtins.__dict__
-    if not k.startswith("__")
-}
-SCT_CTX = create_sct_context(State, sct_dict)
-
-# used in test_exercise, so that scts without Ex() don't run immediately
-globals().update(SCT_CTX)
-
-# put on module for easy importing
-__all__ = list(SCT_CTX.keys())
+# Used by backend
+assert SCT_CTX
diff --git a/sheetwhat/test_exercise.py b/sheetwhat/test_exercise.py
@@ -1,7 +1,8 @@
-from protowhat.Test import TestFail
+from protowhat.failure import Failure, InstructorError
 from protowhat.Reporter import Reporter
+from protowhat.sct_context import get_checks_dict, create_sct_context
 
-from sheetwhat.sct_syntax import SCT_CTX
+from sheetwhat import checks
 from sheetwhat.State import State
 
 
@@ -15,24 +16,37 @@ def test_exercise(
     assert isinstance(student_data, dict)
     assert isinstance(solution_data, dict)
 
-    rep = Reporter()
-    for single_sct in sct:
-        state = State(
-            student_data=student_data,
-            solution_data=solution_data,
-            sct_range=single_sct.get("range"),
-            reporter=rep,
-            force_diagnose=force_diagnose
-        )
+    reporter = Reporter()
+
+    # the available SCT methods
+    sct_dict = get_checks_dict(checks)
 
-        SCT_CTX["Ex"].root_state = state
+    # the available global variables
+    sct_context = create_sct_context(sct_dict)
+    Ex = sct_context["Ex"]
 
+    for single_sct in sct:
         try:
-            exec("\n".join(single_sct.get("sct", [])), SCT_CTX)
-        except TestFail as tf:
-            return tf.payload
+            state = State(
+                student_data=student_data,
+                solution_data=solution_data,
+                sct_range=single_sct.get("range"),
+                reporter=reporter,
+                force_diagnose=force_diagnose,
+            )
+
+            # setting manually to not run create_sct_context in loop
+            Ex.root_state = state
+
+            exec("\n".join(single_sct.get("sct", [])), sct_context)
+
+        except Failure as e:
+            if isinstance(e, InstructorError):
+                # TODO: decide based on context
+                raise e
+            return reporter.build_failed_payload(e.feedback)
 
     if success_msg and isinstance(success_msg, str):
-        rep.success_msg = success_msg
+        reporter.success_msg = success_msg
 
-    return rep.build_final_payload()
+    return reporter.build_final_payload()
diff --git a/tests/helper.py b/tests/helper.py
@@ -1,12 +1,12 @@
-import requests
 import pytest
 import json
 
+from protowhat.failure import TestFail as TF
+from protowhat.Reporter import Reporter
 
+from sheetwhat import checks
 from sheetwhat.State import State
-from sheetwhat.sct_syntax import SCT_CTX
-from protowhat.Reporter import Reporter
-from protowhat.Test import TestFail as TF
+from sheetwhat.sct_context import SCT_CTX
 
 from functools import reduce
 from copy import deepcopy
diff --git a/tests/test_messaging.py b/tests/test_messaging.py
@@ -1,7 +1,7 @@
 import importlib
 import pytest
 from tests.helper import setup_state
-from protowhat.Test import TestFail as TF
+from protowhat.failure import TestFail as TF
 from sheetwhat.checks import *
 
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "0.5.3"`
	`1`	`+__version__ = "0.6.0"`