Site registry for breadcrumb definitions

class autobreadcrumbs.registry.BreadcrumbSite(*args, **kwargs)[source]

Breadcrumbs site registry

Keyword Arguments:
 initial (dict) – Optional initial dictionnary of crumbs urlname->value. Default to an empty dict.
get_names()[source]

Return registred crumb url names.

Returns:List of registred crumb url names, sorted with default sorted() behavior.
Return type:list
get_registry()[source]

Return current registry

Returns:Currrent registry.
Return type:dict
get_title(name)[source]

Get title for given url name.

Parameters:name (string) – Url name.
Returns:Crumb title.
Return type:string or tuple
has_title(name)[source]

Find if given name is registred as a crumb.

Returns:True if name exists in current registry, else False.
Return type:bool
register(name, value)[source]

Register a crumb for given url name.

Parameters:
  • name (string) – Url name.
  • value (string or tuple) – Crumb title to define.
Raises:
  • AlreadyRegistered if the url name is allready registered in
  • crumbs.
reset()[source]

Reset registry to an empty Dict.

unregister(name)[source]

Unregister a crumb.

Parameters:name (string) – Url name.
Raises:NotRegistered if given url name is not registred yet.
update(crumbs)[source]

Update many crumbs

This works like the Dict.update({..}) method.

Parameters:crumbs (dict) – A dict of crumbs (urlname->value).
autobreadcrumbs.registry.breadcrumbs_registry = <autobreadcrumbs.registry.BreadcrumbSite object>

Default breadcrumbs site registry for a Django instance.