revisit 0.0.24__py2.py3-none-any.whl → 0.0.25__py2.py3-none-any.whl

revisit/revisit.py

@@ -45,6 +45,7 @@ class _WrappedResponse(_JSONableBaseModel):
         self.root = self.root.root
 
     def set(self, overwrite=True, **kwargs) -> _WrappedResponse:
+        print('but I got here')
         for key, value in kwargs.items():
             # Disallow changing type
             if key == 'type':
@@ -53,7 +54,7 @@ class _WrappedResponse(_JSONableBaseModel):
             elif key != 'base':
                 if overwrite is True or (overwrite is False and getattr(self.root, key) is None):
                     setattr(self.root, key, value)
-
+        print('do I get here???')
         # Re-validates the model. Returns the new model.
         self.root = _validate_response(self.root.__dict__)
         return self
@@ -509,8 +510,8 @@ def widget(study: _WrappedStudyConfig, revisitPath: str):
         uiConfig.logoPath = newPath
 
     # Copy all files
-    for item in extracted_paths:
-        _copy_file(item['src'], item['dest'])
+    # for item in extracted_paths:
+    #     _copy_file(item['src'], item['dest'])
 
     w = _widget.Widget()
     w.config = json.loads(study.__str__())

{revisit-0.0.24.dist-info → revisit-0.0.25.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: revisit
-Version: 0.0.24
+Version: 0.0.25
 Requires-Dist: anywidget
 Requires-Dist: pandas
 Requires-Dist: pydantic>=2.10.5
@@ -236,7 +236,201 @@ print(component_two)
 '''
 ```
 
+#### `clone(component_name__) -> Component`
 
+**Description**:
+Clones the component with the given new component name.
+
+**Parameters**:  
+| Parameter   | Type     | Description                         | Default Value |
+|-------------|----------|-------------------------------------|---------------|
+| `component_name__`    | `str`   | New component name to assign to cloned component.        | _None_     |
+
+**Returns**:
+- `self`: Returns self for method chaining.
+
+#### **Examples**:
+```python
+test_response = rvt.response(
+    id='test_response',
+    type='shortText',
+    prompt='Original Prompt:',
+    required=True
+)
+
+component_one = rvt.component(
+    component_name__='component_one',
+    type='questionnaire',
+    response=[test_response]
+)
+
+component_two = component_one.clone(component_name__='component_two').edit_response(id='test_response', prompt='New Prompt', required=False)
+
+print(component_one)
+'''
+Expected Output:
+{
+    "response": [
+        {
+            "id": "test_response",
+            "prompt": "Original Prompt:",
+            "required": true,
+            "type": "shortText"
+        }
+    ],
+    "type": "questionnaire"
+}
+'''
+print(component_two)
+'''
+{
+    "response": [
+        {
+            "id": "test_response",
+            "prompt": "New Prompt",
+            "required": false,
+            "type": "shortText"
+        }
+    ],
+    "type": "questionnaire"
+}
+'''
+```
+
+#### `Response`
+
+**Description**:  
+A brief summary of the class's purpose and functionality.
+
+#### **Attributes**:
+| Attribute   | Type     | Description                         | Default Value |
+|-------------|----------|-------------------------------------|---------------|
+| `component_name__`     | `type`   | Description of attribute 1.         | `default`     |
+| `base__`     | `type`   | Description of attribute 2.         | _None_        |
+
+
+#### **Methods**:
+
+#### `set(**kwargs: dict) -> self`
+
+**Description**:
+
+Sets the values of the response to the input dictionary. The `type` cannot be changed and would require creating a new response
+
+**Parameters**:  
+| Parameter   | Type     | Description                         | Default Value |
+|-------------|----------|-------------------------------------|---------------|
+| `**kwargs`    | `dict`   | Dictionary containing valid values for the current response type.        | _None_     |
+
+**Returns**:
+- `self`: Returns self for method chaining.
+
+#### **Raises**:
+- `RevisitError`: If the user attempts to change the `type` attribute of the response, an exception will be raised. Any invalid inputs for the instantiated response type will also raise an exception.
+
+#### **Examples**:
+```python
+response_one = rvt.response(
+    id='r-1',
+    type='shortText',
+    required=False,
+    location='belowStimulus',
+    prompt=''
+)
+
+response_one.set(prompt='New Prompt')
+print(response_one)
+'''
+Expected Output
+{
+    "id": "r-1",
+    "location": "belowStimulus",
+    "prompt": "New Prompt",
+    "required": false,
+    "type": "shortText"
+}
+'''
+
+response_one.set(type='longText')
+# Raises Exception: 'Cannot change type from shortText to longText'
+
+response_one.set(options=[1,2,3])
+
+```
+
+#### `clone() -> Response`
+
+**Description**:
+Clones the response.
+
+**Parameters**:  
+_No parameters_
+
+**Returns**:
+- `self`: Returns self for method chaining.
+
+#### **Examples**:
+```python
+import random
+question_1 = rvt.response(
+    id='q-1',
+    type='shortText',
+    prompt='What is 4 - 2?',
+    required=True,
+    location='belowStimulus'
+)
+
+# Initialize a list with first question
+final_responses = [question_1]
+
+# Randomly generate different arithmetic questions by cloning original question.
+for i in range(2, 21):
+    curr_response = question_1.clone().set(
+        id=f'q-{i}',
+        prompt=f'What is {random.randint(1, 10)} - {random.randint(1, 10)}'
+    )
+    final_responses.append(curr_response)
+
+component_one = rvt.component(
+    component_name__='component_one',
+    type='questionnaire',
+    response=final_responses
+)
+
+print(component_one)
+'''
+Expected Output:
+{
+    "response": [
+        {
+            "id": "q-1",
+            "location": "belowStimulus",
+            "prompt": "What is 4 - 2?",
+            "required": true,
+            "type": "shortText"
+        },
+        {
+            "id": "q-2",
+            "location": "belowStimulus",
+            "prompt": "What is 10 - 4",
+            "required": true,
+            "type": "shortText"
+        },
+
+        ...
+
+        {
+            "id": "q-20",
+            "location": "belowStimulus",
+            "prompt": "What is 2 - 5",
+            "required": true,
+            "type": "shortText"
+        }
+    ],
+    "type": "questionnaire"
+}
+'''
+```
 
 ## Development
 

{revisit-0.0.24.dist-info → revisit-0.0.25.dist-info}/RECORD

@@ -1,10 +1,10 @@
 revisit/StudyConfigSchema.json,sha256=xtzwZifuPJoiHASx0o8PHqBuh5L30mjBlhQ5eqsYm10,132168
 revisit/__init__.py,sha256=QCvYt8m9QwpjcK4dv6GlLMUDCzRXGy16cua1r2biNCg,255
 revisit/models.py,sha256=FRy8IlUAtDS3gdmZwwvqR935lbViTPnnr7k0CAkDkzI,134084
-revisit/revisit.py,sha256=FDf9Asth1q4iArnedgiswUVgXxWfLIqz60UPtoJbXb0,27707
+revisit/revisit.py,sha256=VaHcbySp18VjpIJ3z-_XfQN93RbS4_ZMQs50Vs7feuA,27776
 revisit/widget.py,sha256=VvFqRvvvn86fW8ASe1pxaAvh5ZLvvSRThI5XtlCdgcg,915
 revisit/static/widget.css,sha256=TLu5F6k0CvowQtmApPswG-JZUXYszo7a10dVWKnZsIg,647
 revisit/static/widget.js,sha256=jjc-RvauEnU8dHCR7oGSjg0y1CRXtAlw1-4yDeSbdKE,186472
-revisit-0.0.24.dist-info/METADATA,sha256=1LhDxD-uvXpL3qAiS2MZfV3ct24J-fFsZBwQA3XJf8Y,8840
-revisit-0.0.24.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
-revisit-0.0.24.dist-info/RECORD,,
+revisit-0.0.25.dist-info/METADATA,sha256=nsZQ-i0vAB_kwBEMV4YbaF6W4F1k0s5XsY0p-KltFf0,13510
+revisit-0.0.25.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+revisit-0.0.25.dist-info/RECORD,,