Resources

BaseResource

Methods

class hyperadmin.resources.resources.BaseResource(**kwargs)

Bases: hyperadmin.endpoints.GlobalSiteMixin, hyperadmin.endpoints.VirtualEndpoint

A collection of endpoints representing a particular service

resource_class = ''

form_class

alias of EmptyForm

resource_item_class

alias of ResourceItem

name_suffix = 'resource'

resource_adaptor = None

The object representing the resource connection. Typically passed in during construction

fork(**kwargs)

resource

post_register()

get_app_name()

Return the application name of this resource. Provides the return value of the app_name property.

app_name

Set or get the application name

get_resource_name()

Return the name of this resource. Provides the return value of the resource_name property.

resource_name

Set or get the name of the resource

get_resource_slug()

Return the slug of this resource. Provides the return value of the resource_slug property.

resource_slug

Set or get the slug of the resource

get_prompt()

get_base_url_name_suffix()

register_endpoints()

register_endpoint(endpoint_cls, **kwargs)

get_view_endpoints()

Returns a list of tuples containing (endpoint class, endpoint kwargs)

get_children_endpoints()

reverse(name, *args, **kwargs)

get_state_data()

get_indexes()

get_index(name)

get_index_query(name)

get_item_url(item)

get_related_resource_from_field(field)

get_html_type_from_field(field)

get_absolute_url()

get_url(**kwargs)

get_resource_link_item()

get_index_endpoint()

get_breadcrumb()

get_breadcrumbs()

get_paginator_kwargs()

emit_event(event, item_list=None)

Fires of the resource_event signal

ResourceEndpoint

Methods

class hyperadmin.resources.endpoints.ResourceEndpoint(**kwargs)

Bases: hyperadmin.endpoints.Endpoint

resource

create_link_collection()

get_resource_item(instance, **kwargs)

get_instances()

get_common_state()

common_state

get_resource_link(**kwargs)

get_item_url(item)

get_item_prompt(item)

get_form_class()

get_form_kwargs(**kwargs)

get_item_form_class()

get_item_form_kwargs(**kwargs)

get_namespaces()

get_item_namespaces(item)

get_item_link(item)

get_breadcrumbs()

api_permission_check(api_request, endpoint)

create_apirequest(**kwargs)

expand_template_names(suffixes)

get_context_data(**kwargs)

get_datatap(**kwargs)

ResourceItem

Methods

class hyperadmin.resources.hyperobjects.ResourceItem(endpoint, instance, datatap=None)

Bases: hyperadmin.hyperobjects.Item

resource