revisit 0.0.8__tar.gz → 0.0.10__tar.gz

{revisit-0.0.8 → revisit-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: revisit
-Version: 0.0.8
+Version: 0.0.10
 Requires-Dist: anywidget
 Requires-Dist: ipykernel>=6.29.5
 Requires-Dist: pydantic>=2.10.5
@@ -63,7 +63,7 @@ in the notebook.
 ## CODE GEN
 
 ```bash
-datamodel-codegen --input StudyConfigSchema.json --output models.py  --custom-template-dir custom_templates --output-model-type pydantic_v2.BaseModel --additional-imports typing.TypedDict --input-file-type jsonschema --special-field-name-prefix we_are_going_to_replace_this && sed -i '' 's/we_are_going_to_replace_this_//g'  src/revisit/models.py
+datamodel-codegen --input StudyConfigSchema.json --output src/revisit/models.py  --custom-template-dir custom_templates --output-model-type pydantic_v2.BaseModel --additional-imports "typing.TypedDict, warnings" --input-file-type jsonschema --special-field-name-prefix we_are_going_to_replace_this && sed -i '' 's/we_are_going_to_replace_this_//g'  src/revisit/models.py
 ```
 
 ## TESTS

{revisit-0.0.8 → revisit-0.0.10}/README.md

@@ -52,7 +52,7 @@ in the notebook.
 ## CODE GEN
 
 ```bash
-datamodel-codegen --input StudyConfigSchema.json --output models.py  --custom-template-dir custom_templates --output-model-type pydantic_v2.BaseModel --additional-imports typing.TypedDict --input-file-type jsonschema --special-field-name-prefix we_are_going_to_replace_this && sed -i '' 's/we_are_going_to_replace_this_//g'  src/revisit/models.py
+datamodel-codegen --input StudyConfigSchema.json --output src/revisit/models.py  --custom-template-dir custom_templates --output-model-type pydantic_v2.BaseModel --additional-imports "typing.TypedDict, warnings" --input-file-type jsonschema --special-field-name-prefix we_are_going_to_replace_this && sed -i '' 's/we_are_going_to_replace_this_//g'  src/revisit/models.py
 ```
 
 ## TESTS

{revisit-0.0.8 → revisit-0.0.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "revisit"
-version = "0.0.8"
+version = "0.0.10"
 dependencies = [
     "anywidget",
     "ipykernel>=6.29.5",

{revisit-0.0.8 → revisit-0.0.10}/src/revisit/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  StudyConfigSchema.json
-#   timestamp: 2025-01-10T22:02:50+00:00
+#   timestamp: 2025-01-11T22:20:26+00:00
 
 from __future__ import annotations
 
@@ -53,6 +53,7 @@ class Type(Enum):
     image = 'image'
     website = 'website'
     questionnaire = 'questionnaire'
+    vega = 'vega'
 
 
 class Order(Enum):
@@ -1490,6 +1491,238 @@ class ResponseType(TypedDict):
 warnings.filterwarnings("ignore", module="pydantic")
 
 
+class VegaComponentConfig(BaseModel):
+    model_config = ConfigDict(extra='forbid', populate_by_name=True)
+    allowFailedTraining: Optional[bool] = Field(
+        None,
+        description='Controls whether the component should allow failed training. If not provided, the default is true.',
+    )
+    config: Dict[str, Any] = Field(..., description='The vega-lite configuration.')
+    correctAnswer: Optional[List[Answer]] = Field(
+        None,
+        description='The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.',
+    )
+    description: Optional[str] = Field(
+        None,
+        description='The description of the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    instruction: Optional[str] = Field(
+        None,
+        description='The instruction of the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    instructionLocation: Optional[ResponseBlockLocation] = Field(
+        None, description='The location of the instructions.'
+    )
+    meta: Optional[Dict[str, Any]] = Field(
+        None,
+        description='The meta data for the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    nextButtonDisableTime: Optional[float] = Field(
+        None,
+        description='A timeout (in ms) after which the next button will be disabled.',
+    )
+    nextButtonEnableTime: Optional[float] = Field(
+        None, description='A timer (in ms) after which the next button will be enabled.'
+    )
+    nextButtonLocation: Optional[ResponseBlockLocation] = Field(
+        None, description='The location of the next button.'
+    )
+    nextButtonText: Optional[str] = Field(
+        None, description='The text that is displayed on the next button.'
+    )
+    provideFeedback: Optional[bool] = Field(
+        None,
+        description='Controls whether the component should provide feedback to the participant, such as in a training trial. If not provided, the default is false.',
+    )
+    recordAudio: Optional[bool] = Field(
+        None,
+        description='Whether or not to record audio for a component. Only relevant if StudyConfig.recordStudyAudio is true. Defaults to true.',
+    )
+    response: List[Response] = Field(..., description='The responses to the component')
+    trainingAttempts: Optional[float] = Field(
+        None,
+        description='The number of training attempts allowed for the component. The next button will be disabled until either the correct answer is given or the number of attempts is reached. When the number of attempts is reached, if the answer is incorrect still, the correct value will be shown to the participant. The default value is 2. Providing a value of -1 will allow infinite attempts and the participant must enter the correct answer to continue, and reVISit will not show the correct answer to the user.',
+    )
+    type: Literal['vega']  # End of class
+
+
+class VegaComponentConfigType(TypedDict):
+    model_config = ConfigDict(extra='forbid', populate_by_name=True)
+    allowFailedTraining: Optional[bool] = Field(
+        None,
+        description='Controls whether the component should allow failed training. If not provided, the default is true.',
+    )
+    config: Dict[str, Any] = Field(..., description='The vega-lite configuration.')
+    correctAnswer: Optional[List[Answer]] = Field(
+        None,
+        description='The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.',
+    )
+    description: Optional[str] = Field(
+        None,
+        description='The description of the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    instruction: Optional[str] = Field(
+        None,
+        description='The instruction of the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    instructionLocation: Optional[ResponseBlockLocation] = Field(
+        None, description='The location of the instructions.'
+    )
+    meta: Optional[Dict[str, Any]] = Field(
+        None,
+        description='The meta data for the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    nextButtonDisableTime: Optional[float] = Field(
+        None,
+        description='A timeout (in ms) after which the next button will be disabled.',
+    )
+    nextButtonEnableTime: Optional[float] = Field(
+        None, description='A timer (in ms) after which the next button will be enabled.'
+    )
+    nextButtonLocation: Optional[ResponseBlockLocation] = Field(
+        None, description='The location of the next button.'
+    )
+    nextButtonText: Optional[str] = Field(
+        None, description='The text that is displayed on the next button.'
+    )
+    provideFeedback: Optional[bool] = Field(
+        None,
+        description='Controls whether the component should provide feedback to the participant, such as in a training trial. If not provided, the default is false.',
+    )
+    recordAudio: Optional[bool] = Field(
+        None,
+        description='Whether or not to record audio for a component. Only relevant if StudyConfig.recordStudyAudio is true. Defaults to true.',
+    )
+    response: List[Response] = Field(..., description='The responses to the component')
+    trainingAttempts: Optional[float] = Field(
+        None,
+        description='The number of training attempts allowed for the component. The next button will be disabled until either the correct answer is given or the number of attempts is reached. When the number of attempts is reached, if the answer is incorrect still, the correct value will be shown to the participant. The default value is 2. Providing a value of -1 will allow infinite attempts and the participant must enter the correct answer to continue, and reVISit will not show the correct answer to the user.',
+    )
+    type: Literal['vega']
+
+
+warnings.filterwarnings("ignore", module="pydantic")
+
+
+class VegaComponentPath(BaseModel):
+    model_config = ConfigDict(extra='forbid', populate_by_name=True)
+    allowFailedTraining: Optional[bool] = Field(
+        None,
+        description='Controls whether the component should allow failed training. If not provided, the default is true.',
+    )
+    correctAnswer: Optional[List[Answer]] = Field(
+        None,
+        description='The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.',
+    )
+    description: Optional[str] = Field(
+        None,
+        description='The description of the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    instruction: Optional[str] = Field(
+        None,
+        description='The instruction of the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    instructionLocation: Optional[ResponseBlockLocation] = Field(
+        None, description='The location of the instructions.'
+    )
+    meta: Optional[Dict[str, Any]] = Field(
+        None,
+        description='The meta data for the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    nextButtonDisableTime: Optional[float] = Field(
+        None,
+        description='A timeout (in ms) after which the next button will be disabled.',
+    )
+    nextButtonEnableTime: Optional[float] = Field(
+        None, description='A timer (in ms) after which the next button will be enabled.'
+    )
+    nextButtonLocation: Optional[ResponseBlockLocation] = Field(
+        None, description='The location of the next button.'
+    )
+    nextButtonText: Optional[str] = Field(
+        None, description='The text that is displayed on the next button.'
+    )
+    path: str = Field(
+        ...,
+        description='The path to the vega file. This should be a relative path from the public folder.',
+    )
+    provideFeedback: Optional[bool] = Field(
+        None,
+        description='Controls whether the component should provide feedback to the participant, such as in a training trial. If not provided, the default is false.',
+    )
+    recordAudio: Optional[bool] = Field(
+        None,
+        description='Whether or not to record audio for a component. Only relevant if StudyConfig.recordStudyAudio is true. Defaults to true.',
+    )
+    response: List[Response] = Field(..., description='The responses to the component')
+    trainingAttempts: Optional[float] = Field(
+        None,
+        description='The number of training attempts allowed for the component. The next button will be disabled until either the correct answer is given or the number of attempts is reached. When the number of attempts is reached, if the answer is incorrect still, the correct value will be shown to the participant. The default value is 2. Providing a value of -1 will allow infinite attempts and the participant must enter the correct answer to continue, and reVISit will not show the correct answer to the user.',
+    )
+    type: Literal['vega']  # End of class
+
+
+class VegaComponentPathType(TypedDict):
+    model_config = ConfigDict(extra='forbid', populate_by_name=True)
+    allowFailedTraining: Optional[bool] = Field(
+        None,
+        description='Controls whether the component should allow failed training. If not provided, the default is true.',
+    )
+    correctAnswer: Optional[List[Answer]] = Field(
+        None,
+        description='The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.',
+    )
+    description: Optional[str] = Field(
+        None,
+        description='The description of the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    instruction: Optional[str] = Field(
+        None,
+        description='The instruction of the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    instructionLocation: Optional[ResponseBlockLocation] = Field(
+        None, description='The location of the instructions.'
+    )
+    meta: Optional[Dict[str, Any]] = Field(
+        None,
+        description='The meta data for the component. This is used to identify and provide additional information for the component in the admin panel.',
+    )
+    nextButtonDisableTime: Optional[float] = Field(
+        None,
+        description='A timeout (in ms) after which the next button will be disabled.',
+    )
+    nextButtonEnableTime: Optional[float] = Field(
+        None, description='A timer (in ms) after which the next button will be enabled.'
+    )
+    nextButtonLocation: Optional[ResponseBlockLocation] = Field(
+        None, description='The location of the next button.'
+    )
+    nextButtonText: Optional[str] = Field(
+        None, description='The text that is displayed on the next button.'
+    )
+    path: str = Field(
+        ...,
+        description='The path to the vega file. This should be a relative path from the public folder.',
+    )
+    provideFeedback: Optional[bool] = Field(
+        None,
+        description='Controls whether the component should provide feedback to the participant, such as in a training trial. If not provided, the default is false.',
+    )
+    recordAudio: Optional[bool] = Field(
+        None,
+        description='Whether or not to record audio for a component. Only relevant if StudyConfig.recordStudyAudio is true. Defaults to true.',
+    )
+    response: List[Response] = Field(..., description='The responses to the component')
+    trainingAttempts: Optional[float] = Field(
+        None,
+        description='The number of training attempts allowed for the component. The next button will be disabled until either the correct answer is given or the number of attempts is reached. When the number of attempts is reached, if the answer is incorrect still, the correct value will be shown to the participant. The default value is 2. Providing a value of -1 will allow infinite attempts and the participant must enter the correct answer to continue, and reVISit will not show the correct answer to the user.',
+    )
+    type: Literal['vega']
+
+
+warnings.filterwarnings("ignore", module="pydantic")
+
+
 class WebsiteComponent(BaseModel):
     model_config = ConfigDict(extra='forbid', populate_by_name=True)
     allowFailedTraining: Optional[bool] = Field(
@@ -1623,6 +1856,9 @@ class BaseComponents1(BaseModel):
         None,
         description='Controls whether the component should allow failed training. If not provided, the default is true.',
     )
+    config: Optional[Dict[str, Any]] = Field(
+        None, description='The vega-lite configuration.'
+    )
     correctAnswer: Optional[List[Answer]] = Field(
         None,
         description='The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.',
@@ -1691,6 +1927,9 @@ class BaseComponents1Type(TypedDict):
         None,
         description='Controls whether the component should allow failed training. If not provided, the default is true.',
     )
+    config: Optional[Dict[str, Any]] = Field(
+        None, description='The vega-lite configuration.'
+    )
     correctAnswer: Optional[List[Answer]] = Field(
         None,
         description='The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.',
@@ -1956,6 +2195,9 @@ class InheritedComponent(BaseModel):
         description='Controls whether the component should allow failed training. If not provided, the default is true.',
     )
     baseComponent: str
+    config: Optional[Dict[str, Any]] = Field(
+        None, description='The vega-lite configuration.'
+    )
     correctAnswer: Optional[List[Answer]] = Field(
         None,
         description='The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.',
@@ -2025,6 +2267,9 @@ class InheritedComponentType(TypedDict):
         description='Controls whether the component should allow failed training. If not provided, the default is true.',
     )
     baseComponent: str
+    config: Optional[Dict[str, Any]] = Field(
+        None, description='The vega-lite configuration.'
+    )
     correctAnswer: Optional[List[Answer]] = Field(
         None,
         description='The correct answer to the component. This is used for training trials where the user is shown the correct answer after a guess.',
@@ -2444,6 +2689,17 @@ class ReactComponentType(TypedDict):
     type: Literal['react-component']
 
 
+class VegaComponent(RootModel[Union[VegaComponentPath, VegaComponentConfig]]):
+    root: Union[VegaComponentPath, VegaComponentConfig]
+
+
+# End of class
+
+
+class VegaComponentType(TypedDict):
+    root: Union[VegaComponentPath, VegaComponentConfig]
+
+
 class IndividualComponent(
     RootModel[
         Union[
@@ -2452,6 +2708,7 @@ class IndividualComponent(
             ImageComponent,
             WebsiteComponent,
             QuestionnaireComponent,
+            VegaComponent,
         ]
     ]
 ):
@@ -2461,6 +2718,7 @@ class IndividualComponent(
         ImageComponent,
         WebsiteComponent,
         QuestionnaireComponent,
+        VegaComponent,
     ]
 
 
@@ -2474,6 +2732,7 @@ class IndividualComponentType(TypedDict):
         ImageComponent,
         WebsiteComponent,
         QuestionnaireComponent,
+        VegaComponent,
     ]
 
 

{revisit-0.0.8 → revisit-0.0.10}/src/revisit/revisit.py

@@ -88,7 +88,6 @@ class _WrappedComponent(_JSONableBaseModel):
         return None
 
     def edit_response(self, id: str, **kwargs) -> _WrappedComponent:
-        print(self.root.response)
         for r in self.root.response:
             if r.root.id == id:
                 # Get dict 
@@ -529,22 +528,30 @@ def _generate_possible_component_types():
 # Generates mappings between the response class name and the
 # type string literal. Creates the reversed mapping as well.
 def _generate_possible_types(orig_cls):
-    response_type_hint = get_type_hints(orig_cls).get('root')
-    response_types = get_args(response_type_hint)
+    type_hints = get_type_hints(orig_cls).get('root')
+    types = get_args(type_hints)
     type_hints = {}
     type_hints_reversed = {}
-    for cls in response_types:
-        curr_type = get_type_hints(cls).get('type')
-        curr_origin = get_origin(get_type_hints(cls).get('type'))
-        if curr_origin is Literal:
-            type_hints[cls.__name__] = set([get_args(curr_type)[0]])
-            type_hints_reversed[get_args(curr_type)[0]] = cls.__name__
-        elif isinstance(curr_type, type) and issubclass(curr_type, Enum):
-            enum_list = [member.value for member in curr_type]
-            type_hints[cls.__name__] = set(enum_list)
-            for item in enum_list:
-                type_hints_reversed[item] = cls.__name__
-
+    for cls in types:
+        # If class is the union of two separate classes,
+        # need to get types from root
+        if get_type_hints(cls).get('root') is not None:
+            test = get_type_hints(cls).get('root')
+            for item in get_args(test):
+                curr_type = get_type_hints(item).get('type')
+                type_hints[cls.__name__] = set([get_args(curr_type)[0]])
+                type_hints_reversed[get_args(curr_type)[0]] = cls.__name__
+        else:
+            curr_type = get_type_hints(cls).get('type')
+            curr_origin = get_origin(get_type_hints(cls).get('type'))
+            if curr_origin is Literal:
+                type_hints[cls.__name__] = set([get_args(curr_type)[0]])
+                type_hints_reversed[get_args(curr_type)[0]] = cls.__name__
+            elif isinstance(curr_type, type) and issubclass(curr_type, Enum):
+                enum_list = [member.value for member in curr_type]
+                type_hints[cls.__name__] = set(enum_list)
+                for item in enum_list:
+                    type_hints_reversed[item] = cls.__name__
     return (type_hints, type_hints_reversed)
 
 
@@ -596,6 +603,11 @@ def _get_filtered_kwargs(class_type: Any, kwargs):
 
     valid_fields = set()
     for model in possible_items:
+        if 'root' in model.model_fields.keys():
+            unioned_classes = (get_args(get_type_hints(model).get('root')))
+            for cls in unioned_classes:
+                valid_fields.update(cls.model_fields.keys())
+                
         valid_fields.update(model.model_fields.keys())
 
     return {key: value for key, value in kwargs.items() if key in valid_fields}