Manifest

CodeMirror manifest

From its registred Codemirror configurations, a manifest instance is able to:

• Return needed js files, either for all registred configs or a single one;

• Return needed css files, either for all registred configs or a single one;

• Return Codemirror configuration parameters as a dict for a registred config.

A Codemirror config is selected from its name in settings.CODEMIRROR_SETTINGS.

class djangocodemirror.manifest.CodeMirrorManifest

CodeMirror configurations manifest.

A configuration contains every parameters and assets to use with a CodeMirror instance.

registry

Configuration registry.

Type:

dict

default_internal_config

Default internal parameters.

Type:

dict

_internal_only

Names of internal parameters only that will be exluded from CodeMirror parameters.

Type:

list

register(name)

Register configuration for an editor instance.

Parameters:

name (string) – Config name from available ones in settings.CODEMIRROR_SETTINGS.

Raises:

UnknowConfigError – If given config name does not exist in settings.CODEMIRROR_SETTINGS.

Returns:

Registred config dict.

Return type:

dict

register_many(*args)

Register many configuration names.

Parameters:

*args – Config names as strings.

Returns:

List of registered configs.

Return type:

list

autoregister()

Register every available configuration from settings.CODEMIRROR_SETTINGS.

resolve_mode(name)

From given mode name, return mode file path from settings.CODEMIRROR_MODES map.

Parameters:

name (string) – Mode name.

Raises:

KeyError – When given name does not exist in settings.CODEMIRROR_MODES.

Returns:

Mode file path.

Return type:

string

resolve_theme(name)

From given theme name, return theme file path from settings.CODEMIRROR_THEMES map.

Parameters:

name (string) – Theme name.

Raises:

KeyError – When given name does not exist in settings.CODEMIRROR_THEMES.

Returns:

Theme file path.

Return type:

string

get_configs(name=None)

Returns registred configurations.

• If name argument is not given, default behavior is to return every config from all registred config;

• If name argument is given, just return its config and nothing else;

Keyword Arguments:

name (string) – Specific configuration name to return.

Raises:

• NotRegisteredError – If given config name does not exist in

• registry. –

Returns:

Configurations.

Return type:

dict

get_config(name)

Return a registred configuration for given config name.

Parameters:

name (string) – A registred config name.

Raises:

• NotRegisteredError – If given config name does not exist in

• registry. –

Returns:

Configuration.

Return type:

dict

get_codemirror_parameters(name)

Return CodeMirror parameters for given configuration name.

This is a reduced configuration from internal parameters.

Parameters:

name (string) – Config name from available ones in settings.CODEMIRROR_SETTINGS.

Returns:

Parameters.

Return type:

dict

js(name=None)

Returns all needed Javascript filepaths for given config name (if given) or every registred config instead (if no name is given).

Keyword Arguments:

name (string) – Specific config name to use instead of all.

Returns:

List of Javascript file paths.

Return type:

list

js_bundle_names(name=None)

Returns all needed Javascript Bundle names for given config name (if given) or every registred config instead (if no name is given).

Keyword Arguments:

name (string) – Specific config name to use instead of all.

Returns:

List of webasset bundle names.

Return type:

list

css(name=None)

Returns all needed CSS filepaths for given config name (if given) or every registred config instead (if no name is given).

Keyword Arguments:

name (string) – Specific config name to use instead of all.

Returns:

List of CSS file paths.

Return type:

list

css_bundle_names(name=None)

Returns all needed CSS Bundle names for given config name (if given) or every registred config instead (if no name is given).

Keyword Arguments:

name (string) – Specific config name to use instead of all.

Returns:

List of webasset bundle names.

Return type:

list