Reflexes

Server-side Reflexes inherit from sockpuppet.Reflex. They hold logic responsible for performing operations like writing to your backend data stores. Reflexes are not concerned with rendering because rendering is delegated to the Django view.
Glossary
Sockpuppet: The name of this project, which has a JS websocket client and a Django-based server component, which is based on django-channels.
Stimulus: An incredibly simple yet powerful JS framework by the creators of Rails.
"a Reflex": Used to describe the full, round-trip life-cycle of a Sockpuppet operation, from client to server and back again
Reflex class: A Python class that inherits from sockpuppet.Reflex and lives in your reflexes folder or reflex.py, this is where your Reflex actions are implemented.
Reflex action: A method in a Reflex class, called in response to activity in the browser. It has access to several special accessors containing all of the Reflex controller element's attributes
Reflex controller: A Stimulus controller that imports the StimulusReflex client library. It has a stimulate method for triggering Reflexes and like all Stimulus controllers, it's aware of the element it is attached to - as well as any Stimulus targets in its DOM hierarchy
Reflex controller element: The DOM element upon which the data-reflex attribute is placed, which often has data attributes intended to be delivered to the server during a Reflex action
Calling a Reflex
Regardless of whether you use declarative Reflex calls via data-reflex attributes in your HTML or if you are using JavaScript, ultimately the stimulate method on your Stimulus controller is being called. We touched on this briefly in the Quick Start chapter; now we are going to document the function signature so that you fully understand what's happening behind the scenes.
All Stimulus controllers that have had StimulusReflex.register(this) called in their connect method gain a stimulate method.
1
this.stimulate(string target, [DOMElement element], ...[JSONObject argument])
Copied!
target, required (exception: see "Requesting a Refresh" below): A string containing the server Reflex class and method, in the form "ExampleReflex#increment".
element, optional: A reference to a DOM element which will provide both attributes and scoping selectors. Frequently pointed to event.target in JavaScript. Defaults to the DOM element of the controller in scope.
argument, optional: A splat of JSON-compliant JavaScript datatypes - array, object, string, numeric or boolean - can be received by the server Reflex action as one or many ordered arguments. Defaults to no argument(s). Note: the method signature has to match. If the Reflex action is expecting two arguments and doesn't receive two arguments, it will raise an exception.
Requesting a "refresh"
If you are building advanced workflows, there are edge cases where you may want to initiate a Reflex action that does nothing but re-render the view template and morph any new changes into the DOM. While this shouldn't be your primary tool, it's possible for your data to be mutated by destructive external side effects. 🧟
1
this.stimulate()
Copied!
Calling stimulate with no parameters invokes a special global Reflex that allows you to force a re-render of the current state of your application UI. This is the same thing that the user would see if they hit their browser's Refresh button, except without the painfully slow round-trip cycle.
It's also possible to trigger this global Reflex by passing nothing but a browser event to the data-reflex attribute. For example, the following button element will refresh the page content every time the user presses it:
1
<button data-reflex="click">Refresh</button>
Copied!
The Reflex Class
StimulusReflex makes the following properties available to the developer inside Reflex actions:
Properties
consumer - the Websocket connection from django channels.
request - a django request object
request.post - If the page contains a form, it will find the closest form which and the parameters will be contained here.
session - the Django session store for the current visitor
url - the URL of the page that triggered the reflex
element - an object that represents the HTML element that triggered the reflex
params - Contains the form parameters for the closest form
Methods
get_context_data - Accesses the context data from the view associated with the reflex. You will know that the method is triggered from the reflex because the context now contains stimulus_reflex which is equal to True. This will be available from kwargs so you can modify the context based on whether it is a reflex or not.
get_channel_id - By default this returns the session key which is used to deliver the websocket update to the client. This function can be overridden if you need a different key for transferring the update.
reflex and process are reserved words inside Reflex classes. You cannot create Reflex actions with these names.
Modify or add to the view context
When a reflex is triggered you can modify the current context of the view or add more context which previously didn't exist when the view rendered in the normal request-response cycle.
Untitled
Untitled
1
from sockpuppet.reflex import Reflex
2
​
3
class ExampleReflex(Reflex):
4
    def work(self):
5
        # All new instance variables in the reflex will be accessible
6
        # in the context during rendering.
7
        self.instance_variable = 'hello world'
8
​
9
        context = self.get_context_data()
10
        context['a_key'] = 'a pink elephant'
11
        # If "a_key" existed in the context before the reflex was triggered
12
        # the context variable will now be modified to "a pink elephant"
13
​
14
        # if it didn't exist, the context variable is then created with the
15
        # data "a pink elephant" 🐘
Copied!
1
<div>
2
    <!-- When the work reflex is triggered "new_variable" will be
3
    available in the context -->
4
    <span>{{ instance_variable }}</span>
5
​
6
    <!-- This will show up as "a pink elephant" when triggering the reflex -->
7
    <span>{{ a_key }}</span>
8
</div>
Copied!
The element property
The element property contains all of the Reflex controller's DOM element attributes as well as other properties like, tag_name, checked and value.
Most values are strings. The only exceptions are checked and selected which are booleans.
Elements that support multiple values (like <select multiple>, or a collection of checkboxes with equal name), will emit an additional values property. The value property will contain a comma-separated string of the checked options.
Here's an example that outlines how you can interact with the element property in your Reflexes.
app/templates/show.html
1
<checkbox id="example" label="Example" checked
2
  data-reflex="ExampleReflex#work" data-value="123" />
Copied!
Untitled
1
from sockpuppet.reflex import Reflex
2
​
3
class ExampleReflex(Reflex):
4
    def work(self):
5
        self.element.attributes          # a dictionary that represents all attributes of the HTML element
6
        self.element.dataset             # a dictionary that represents the HTML element's dataset
7
​
8
        self.element.attributes['id']           # => 'example'
9
        self.element.attributes['tag_name']     # => 'CHECKBOX'
10
        self.element.attributes['checked']      # => 'true'
11
        self.element.attributes['label']        # => 'Example'
12
        self.element.attributes['data-reflex']  # => 'ExampleReflex#work'
13
        self.element.dataset['reflex']          # => 'ExampleReflex#work'
14
        self.element.attributes['data-value']   # => '123'
15
        self.element.dataset['value']           # => '123'
Copied!
When Sockpuppet is rendering your template, a context variable named stimulus_reflex is available to your Django view and set to true.
You can use this flag to create branching logic to control how the template might look different if it's a Reflex versus a normal page refresh.
Inheriting data-attributes from parent elements
You might design your interface such that you have a deeply nested structure of data attributes on parent elements. Instead of writing code to travel your DOM and access those values, you can use the data-reflex-dataset="combined" directive to scoop all data attributes up the hierarchy and pass them as part of the Reflex payload.
1
<div data-post-id="{{ @post.id }}">
2
  <div data-category-id="{{ @category.id }}">
3
    <button data-reflex="click->Comment#create" data-reflex-dataset="combined">Create</button>
4
  </div>
5
</div>
Copied!
This Reflex action will have post-id and category-id accessible:
1
from sockpuppet import reflex
2
​
3
class CommentReflex(reflex.Reflex):
4
  def create(self)
5
    print(element.dataset["post-id"])
6
    print(element.dataset["category-id"])
Copied!
If a data attribute appears several times, the deepest one in the DOM tree is taken. In the following example, data-id would be 2.
1
<div data-id="1">
2
  <button data-id="2" data-reflex="Example#whatever" data-reflex-dataset="combined">Click me</button>
3
</div>
Copied!
Quick Start
Lifecycle
Last modified 9mo ago
Copy link
Contents
Glossary
Calling a Reflex
Requesting a "refresh"
The Reflex Class
Properties
Methods
Modify or add to the view context
The element property
Inheriting data-attributes from parent elements