ReVISitPy

Installation

pip install revisitpy

or with uv:

uv add revisitpy

Usage

The reVISit python package wraps the standard items of the reVISit configuration file with readable, easy-to-use functions. We expose a factory function for each top-level item in the reVISit configuration: studyMetadata, uiConfig, components, sequence, and studyMetadata. Currently, we do not expose a baseComponents function. Instead, base components are still well-defined components and can be passed during the creation of another component. The final configuration will not include base components but will have the expected inherited output.

Each factory function takes in the same parameters as the reVISit configuration file. For example, the studyMetadata function requires the author, organizations, title, version, and description parameters. Robust error output will help you, the user, understand what is required in each function. For the sake of brevity, we do not list every possible parameter since these are already defined in the current study configuration. Instead, we will show additional required/optional parameters as well as additional methods and other exposed functions.

The individual classes (Component, Response, Sequence, StudyMetadata, UIConfig, and StudyConfig) should not be created directly. Instead, you should use the corresponding factory functions to insantiate them (component(), response(), sequence(), studyMetadata(), uiConfig(), and studyConfig()).

Functions

`component(component_name, base, **kwargs) -> Component`

Instantiates a Component class with the given input parameters.

Parameters:

Parameter	Type	Description	Default Value
`component_name__`	`str`	Names the component for use in the final configuration file.	None
`base__`	`Optional[component]`	When a base component is passed, all properties of the base are inherited by the component. Any other specified property during input will override base properties.	None
`**kwargs`	`dict`	The component function requires any property that the component already requires, such as "type". Refer to the configuration documentation for required properties.	None

Returns:

Component: Returns an instantiation of the Component class.

Raises:

RevisitError: If the required properties are not specified, and exception will be raised.

Example:

import revisitpy as rvt

# Initializing a markdown component with an empty response list.
my_component = rvt.component(
    component_name__='my-component',
    response=[],
    type='markdown',
    path='./assets/my-markdown-file.md'
)

# Instantiating a component with the base as "my_component".
my_other_component = rvt.component(
    component_name__='my-other-component',
    base__=my_component,
    path='./assets/my-other-markdown-file.md'
)

`response(**kwargs) -> Response`

Instantiates a Response class with the given input parameters.

Parameters:

Parameter	Type	Description	Default Value
`**kwargs`	`dict`	The component function requires any property that the component already requires, such as "type". Refer to the configuration documentation for required properties.	None

Returns:

Response: Returns an instantiation of the Response class.

Raises:

RevisitError: If the required properties are not specified, and exception will be raised.

Example:

import revisitpy as rvt

# Initializing a matrix radio response
my_response = rvt.response(
    type='matrix-radio',
    answerOptions='likely5',
    questionOptions=['Question 1', 'Question 2', 'Question 3'],
    required=True,
    location='sidebar'
)

`studyMetadata(**kwargs) -> StudyMetadata`

Instantiates a StudyMetadata class with the given parameters.

Parameters:

Parameter	Type	Description	Default Value
`**kwargs`	`dict`	Required properties for the StudyMetadata	None

Returns:

Response: Returns an instantiation of the Response class.

Raises:

RevisitError: If the required properties are not specified, and exception will be raised.

Example:

import revisitpy as rvt

# Initializing a matrix radio response
my_response = rvt.response(
    type='matrix-radio',
    answerOptions='likely5',
    questionOptions=['Question 1', 'Question 2', 'Question 3'],
    required=True,
    location='sidebar'
)

`uiConfig(**kwargs) -> UIConfig`

Instantiates a UIConfig class with the given parameters.

Parameters:

Parameter	Type	Description	Default Value
`**kwargs`	`dict`	The component function requires any property that the component already requires, such as "type". Refer to the configuration documentation for required properties.	None

Returns:

Response: Returns an instantiation of the Response class.

Raises:

RevisitError: If the required properties are not specified, and exception will be raised.

Example:

import revisitpy as rvt

# Initializing a matrix radio response
my_response = rvt.response(
    type='matrix-radio',
    answerOptions='likely5',
    questionOptions=['Question 1', 'Question 2', 'Question 3'],
    required=True,
    location='sidebar'
)

`studyConfig(studyMetadata, uiConfig, sequence, schema, components) -> StudyConfig`

Instantiates a the final StudyConfig based on the UIConfig, StudyMetadata, Sequence, and Components input. Note that the components list is completely optional: using the studyConfig factory function automatically populates all components based on their presence in the sequence.

Parameters:

Parameter	Type	Description	Default Value
`studyMetadata`	`StudyMetadata`	An instance of the `StudyMetadata` class	None
`uiConfig`	`UIConfig`	An instance of the `UIConfig` class	None
`sequence`	`ComponentBlock`	The top level member of your sequence.	None
`components`	`Optional[List[Component]]`	The list of `Component`s to be added to the config. This is automatically populated based on the inputted sequence	`[]`
`schema`	`str`	The valid `$schema` value for the config. You can always find the most recent schema value in the public repository of our main study repository, such as here	None

Returns:

StudyConfig: Returns an instantiation of the StudyConfig class.

Raises:

RevisitError: If the required properties are not specified, and exception will be raised.

Example:

ui_config = rvt.uiConfig(...)
study_metadata = rvt.studyMetadata(...)
comp_one = rvt.component(...)
comp_two = rvt.component(...)
sequence = rvt.sequence(order='fixed',components=[comp_one, comp_two])

study = rvt.studyConfig(
    schema='https://raw.githubusercontent.com/revisit-studies/study/v2.0.0-rc5/src/parser/StudyConfigSchema.json',
    studyMetadata=study_metadata,
    uiConfig=ui_config,
    sequence=sequence # <-- Do not need to add components list separately if they are already in the sequence.
)

Classes

`Component`

The class that is instantiated when calling the component factory function. Used to define the components in the study configuration file.

Attributes:

Attribute	Type	Description	Default Value
`component_name__`	`str`	Name of the component to be used as the key in the study config.	None
`base__`	`Optional[Component]`	The base component which is inherited by this component.	None
`metadata__`	`Optional[dict]`	A dictionary specifying metadata of the object. This is purely used for additional properties which are not written to the config and may be used to attach arbitrary data to the component without affecting the final output.	None

Methods:

`responses(responses: List[Response]) -> self`

Description:
Sets responses for the component

Parameters:

Parameter	Type	Description	Default Value
`responses`	`List[Response]`	Valid list of responses.	None

Returns:

self: Returns self for method chaining.

Raises:

RevisitError: If the list is not a valid list of responses, raises and exception.

Example:

my_response=rvt.response(
    id='my_response',
    type='dropdown',
    options=['Option 1', 'Option 2']
)

my_component = rvt.component(
    component_name__='my_component',
    type='markdown',
    path='assets/my-markdown-file.md'
).responses([
    my_response
])

`get_response(id: str) -> Response | None`

Description: Returns the response of the component with the given ID. If the Response does not exist, returns None.

Parameters:

Parameter	Type	Description	Default Value
`id`	`str`	ID of Response	None

Returns:

Response: The response with the given ID.

Example:

the_response = my_component.get_response(id='the_response')

if the_response is not None:
    print(the_response)

`edit_response(id: str, **kwargs: dict) -> self`

Description: Edits the Response in the Component with the given ID. This is done by creating a new copy of the existing Response.

Parameters:

Parameter	Type	Description	Default Value
`id`	`str`	ID of Response	None

Returns:

self: Returns self for method chaining.

Example:

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 = rvt.component(
    component_name__='component_two',
    type='questionnaire',
    response=[test_response]
).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"
}
'''

`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.

Example:

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`

This is the Responsse class. When calling the response factory function, an instantiation of this class is returned.

Attributes:

No attributes

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:

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:

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"
}
'''

`ComponentBlock`

Description:
The ComponentBlock class (also referred to as a "Sequence"). A well-defined sequence simply contains an order and a set of components, with other optional properties. Just as in the nested structure of component blocks in the reVISit study configuration, ComponentBlock classes can be added together.

A ComponentBlock automatically tracks all of its existing Component classes. When the ComponentBlock is added to the study configuration, all components will automatically be added to the high-level components element of the study config.

Attributes:

No attributes

Methods:

`add(other: Union[ComponentBlock, Component]) -> self:`

Description:

Adds two ComponentBlock or Component to the input sequence. When adding two sequences together, the right sequence gets added as a ComponentBlock to the list of components of the left sequence. When the right object is an instance of the Component class, the component is added to the ComponentBlock's list of components.

Parameters:

Parameter	Type	Description	Default Value
`other`	`Union[ComponentBlock, Component]`	Other item adding to left sequence.	None

Returns:

self: Returns self for method chaining.

Raises:

NotImplemented: If the right item is not a Component or ComponentBlock, raises a NotImplemented exception.

Examples:

first_sequence = rvt.sequence(
    order='fixed',
    components=[introduction]
)
second_sequence = rvt.sequence(
    order='random',
    components=[comp_one, comp_two]
)

first_sequence = first_sequence + second_sequence

print(first_sequence)
'''
Expected Output:
{
    "order": "fixed",
    "components" : [
        "introduction",
        {
            "order": "random"
            "components" : [
                "comp_one",
                "comp_two"
            ]
        }
    ]
}
'''
post_study = rvt.component(
    component_name__='post-study',
    type='markdown',
    path='./post-study.md'
)

first_sequence = first_sequence + post_study
print(first_sequence)
'''
Expected Output:
{
    "order": "fixed",
    "components" : [
        "introduction",
        {
            "order": "random"
            "components" : [
                "comp_one",
                "comp_two"
            ]
        },
        "post-study"
    ]
}
'''

`get_component(name: str) -> Component:`

Description:

Fetches the Component with the given component name from the sequence.

Parameters:

Parameter	Type	Description	Default Value
`name`	`str`	string matching the `component_name__` attribute of the desired `Component`.	None

Returns:

Component: Returns desired Component. If no component with specified name is found, returns None.

Examples:

sequence = rvt.sequence(
    order='random',
    components=[comp_one, comp_two]
)

print(sequence.get_component(name='comp_two'))
'''
{
    "type": "markdown",
    "path": "my_markdown_file.md",
    "response": []
}
'''

`permute(factors: List[dict], order: 'fixed' | 'latinSquare' | 'random', numSamples: Optional[int], component_function: Optional[Callable]) -> self`

Description: Permutes the the existing components of the sequence over the given factors. The permute method can be chained to complex study sequences. By default, the factors are attached as metadata__ attributes to each component created. If a component_function is passed in as an argument, all current factors and metadata__ of the component will be passed into the component function. The component function must return a valid Component instance.

Parameters:

Parameter	Type	Description	Default Value
`factors`	`List[dict]`	A list of single-key dictionaries to permute over.	None
`order`	`'fixed' \| 'latinSquare' \| 'random'`	The order to assign to the current permuted component block.	None
`numSamples`	`Optional[int]`	The `numSamples` value to assign to the current permuted block.	None
`component_function`	`Optional[Callable]`	A function defining what component should be generated during permutation. If not provided, the permutation function inherits the existing components in the sequence as new components and applies the factors as metadata. If given, the metadata is passed into the component function as arguments.	None

Returns:

self: Returns self for method chaining.

Raises:

TypeError: The component_function must be able to take in all metadata of the sequence's existing components as well as the current factors. For example, if you start with a component with no metadata and permute over the factors [{'key_1':'value_1'}, {'key_1': 'value_2'}], the component function should be defined to take in the parameter key_1. Otherwise, this will most likely result in a TypeError being raised. If you are chaining multiple permute methods after one another, please note that the the set of factors that are passed into the permute function are applied as metadata to the resulting components. Thus, your function must be able to take in all factors as arguments. To avoid this, you can simply use **kwargs as your parameter input of your component function.

Examples:

Simple Permutation

comp_one = rvt.component(component_name__='my-base', type='markdown', path='./my-markdown.md')

sequence = rvt.component(order='fixed',components=[comp_one])

sequence.permute(
    factors=[{'condition':'A'}, {'condition':'B'}],
    order='random'
)

print(sequence)
'''
Expected Output:
{
    "order": "random", <--- Since there was only one component in the original sequence, order gets overwritten.
    "components": [
        "my-base_condition:A",
        "my-base_condition:B" <--- Note that the default behavior appends the factors to the name
    ]
}

The two components generated are inherently identical, except with different metadata__ attributes. 
These metadata__ attributes are not outputed into the final JSON study config or seen when printing out
the individual components.
'''

sequence.permute(
    factors=[{'type':'1'}, {'type': '2'}]
    order='fixed',
    numSamples=1
)

print(sequence)
'''
Expected Output:
{
    "order": "random",
    "components": [
        {
            "order": "fixed", <--- New order gets added to inner most component blocks.
            "components": [
                "my-base_condition:A_type:1",
                "my-base_condition:A_type:2",
            ],
            "numSamples": 1
        },
        {
            "order": "fixed",
            "components": [
                "my-base_condition:B_type:1",
                "my-base_condition:B_type:2",
            ],
            "numSamples": 1
        },
    ]

}
'''

Using the component_function

# Defining component function.
# Takes in kwargs to prevent conflicts with any existing metadata.
def my_comp_function(**kwargs):
    condition = kwargs.get('condition')
    type_ = kwargs.get('type')
    # If condition and type_ are both defined, return new component.
    if condition is not None and type_ is not None:
        rvt.component(
            type='website'
            component_name__=f"{condition}__{type_}"
            parameters={
                'condition': condition,
                'type': type_
            },
            response=[
                rvt.response(
                    id=f"response_{condition}_{type_}",
                    type="longText",
                    prompt=f"How do you feel about condition {condition} and type {type_}?",
                    required=True
                )
            ]
        )

    # If not both defined, return a blank component with "BAD-COMPONENT" name.
    # Useful for debugging
    return rvt.component(type='questionnaire',component_name__="BAD-COMPONENT")

sequence = rvt.sequence(order='fixed').permute(
    factors=[{'condition':'A'}, {'condition':'B'}],
    order='random'
).permute(
    factors=[{'type':'1'}, {'type': '2'}]
    order='fixed',
    numSamples=1,
    component_function=my_comp_function
)
print(sequence)
'''
Expected Output:
{
    "order": "random",
    "components": [
        {
            "order": "fixed", <--- New order gets added to inner most component blocks.
            "components": [
                "A__1",
                "A__2",
            ],
            "numSamples": 1
        },
        {
            "order": "fixed",
            "components": [
                "B__1",
                "B__2"
            ],
            "numSamples": 1
        },
    ]

}
'''

Development

Building

You may need to install hatch locally (do not use uv add hatch since it will add it to project dependencies and be shipped with build).

uv pip install hatch
uv run hatch build
uv run hatch publish

We recommend using uv for development. It will automatically manage virtual environments and dependencies for you.

uv run jupyter lab example.ipynb

Alternatively, create and manage your own virtual environment:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab example.ipynb

The widget front-end code bundles it's JavaScript dependencies. After setting up Python, make sure to install these dependencies locally:

yarn install

While developing, you can run the following in a separate terminal to automatically rebuild JavaScript as you make changes:

yarn run dev

Open example.ipynb in JupyterLab, VS Code, or your favorite editor to start developing. Changes made in js/ will be reflected in the notebook.

CODE GEN

uv pip install datamodel-code-generator
uv run datamodel-codegen --input src/revisitpy/StudyConfigSchema.json --output src/revisitpy/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/revisitpy/models.py

TESTS

cd revisit-py
uv run -m tests.test_module_one

Publishing

Update version number in pyproject.toml

uv run hatch build
uv run hatch publish

If there hatch is not found, run the following:

uv pip install hatch

Files

README.md

Latest commit

History

README.md

File metadata and controls

ReVISitPy

Installation

Usage

Functions

Functions

component(component_name__, base__, **kwargs) -> Component

Parameters:

Returns:

Raises:

Example:

response(**kwargs) -> Response

Parameters:

Returns:

Raises:

Example:

studyMetadata(**kwargs) -> StudyMetadata

Parameters:

Returns:

Raises:

Example:

uiConfig(**kwargs) -> UIConfig

Parameters:

Returns:

Raises:

Example:

studyConfig(studyMetadata, uiConfig, sequence, schema, components) -> StudyConfig

Parameters:

Returns:

Raises:

Example:

Classes

Component

Attributes:

Methods:

responses(responses: List[Response]) -> self

get_response(id: str) -> Response | None

edit_response(id: str, **kwargs: dict) -> self

clone(component_name__) -> Component

Response

Attributes:

Methods:

set(**kwargs: dict) -> self

clone() -> Response

ComponentBlock

Attributes:

Methods:

__add__(other: Union[ComponentBlock, Component]) -> self:

get_component(name: str) -> Component:

permute(factors: List[dict], order: 'fixed' | 'latinSquare' | 'random', numSamples: Optional[int], component_function: Optional[Callable]) -> self

Examples:

Development

Building

CODE GEN

TESTS

Publishing

`component(component_name, base, **kwargs) -> Component`

`response(**kwargs) -> Response`

`studyMetadata(**kwargs) -> StudyMetadata`

`uiConfig(**kwargs) -> UIConfig`

`studyConfig(studyMetadata, uiConfig, sequence, schema, components) -> StudyConfig`

`Component`

`responses(responses: List[Response]) -> self`

`get_response(id: str) -> Response | None`

`edit_response(id: str, **kwargs: dict) -> self`

`clone(component_name__) -> Component`

`Response`

`set(**kwargs: dict) -> self`

`clone() -> Response`

`ComponentBlock`

`add(other: Union[ComponentBlock, Component]) -> self:`

`get_component(name: str) -> Component:`

`permute(factors: List[dict], order: 'fixed' | 'latinSquare' | 'random', numSamples: Optional[int], component_function: Optional[Callable]) -> self`