turbo_helper

Subpackages

• turbo_helper.channels
  • turbo_helper.channels.broadcasts
  • turbo_helper.channels.stream_name
  • turbo_helper.channels.streams_channel
• turbo_helper.templatetags
  • turbo_helper.templatetags.turbo_helper

Submodules

• turbo_helper.apps
• turbo_helper.constants
• turbo_helper.middleware
• turbo_helper.renderers
• turbo_helper.response
• turbo_helper.shortcuts
• turbo_helper.signals
• turbo_helper.stream
• turbo_helper.turbo_power

Package Contents

Classes

HttpResponseSeeOther
TurboStreamResponse

Functions

get_current_request()
redirect_303(to, *args, **kwargs)	Sends an HTTP 303 redirect.
respond_to(request)	Inspired by Rails
after_create_commit(sender)
after_delete_commit(sender)
after_update_commit(sender)
register_turbo_stream_action(name)
dom_id(instance[, prefix])	Generate a unique identifier for a Django model instance, class, or even Python object.

Attributes

turbo_stream

turbo_helper.get_current_request()

class turbo_helper.HttpResponseSeeOther

Bases: django.http.HttpResponseRedirect

status_code

class turbo_helper.TurboStreamResponse(*args, **kwargs)

Bases: django.http.HttpResponse

turbo_helper.redirect_303(to, *args, **kwargs)

Sends an HTTP 303 redirect.

All arguments are forwarded to django.shortcuts.resolve_url to generate the redirect URL.

https://github.com/django/django/blob/9c436a09b3a641874881706495ae07293aa97c2f/django/shortcuts.py#L151

Parameters:

to (Union[str, django.db.models.Model])

Return type:

turbo_helper.response.HttpResponseSeeOther

turbo_helper.respond_to(request)

Inspired by Rails

https://www.writesoftwarewell.com/how-respond_to-method-works-rails/

respond_to do |format|

format.turbo_stream { render turbo_stream: turbo_stream_template }

end

turbo_helper.after_create_commit(sender)

turbo_helper.after_delete_commit(sender)

turbo_helper.after_update_commit(sender)

turbo_helper.register_turbo_stream_action(name)

turbo_helper.turbo_stream

turbo_helper.dom_id(instance, prefix='')

Generate a unique identifier for a Django model instance, class, or even Python object.

Args:

instance (Any): The instance or class for which the identifier is generated. prefix (Optional[str]): An optional prefix to prepend to the identifier. Defaults to an empty string.

Returns:

str: The generated identifier.

Raises:

Exception: If the model instance does not have either the to_key or pk attribute.

Note:

• If instance is a Django model instance, the identifier is generated based on the to_key or pk attribute.

• If instance is a Django model class, the identifier is generated as new_<class_name>.

• If instance is neither a model instance nor a model class, the identifier is generated based on the to_key attribute if available, otherwise it uses the string representation of the instance.

• The prefix argument can be used to prepend a prefix to the generated identifier.

Parameters:

• instance (Any)

• prefix (Optional[str])

Return type:

str