shuup.importer.importing package

Submodules

shuup.importer.importing.importing module

class shuup.importer.importing.importing.ImporterExampleFile(file_name, content_type, template_name=None)

Bases: object

__init__(file_name, content_type, template_name=None)

file_name = ''

content_type = ''

template_name = ''

class shuup.importer.importing.importing.ImporterContext(shop: Shop, language: str, supplier: Supplier = None, user: User = None, **kwargs)

Bases: object

__init__(shop: Shop, language: str, supplier: Supplier = None, user: User = None, **kwargs)

shop: Shop = None

language = None

supplier: Supplier = None

user: User = None

class shuup.importer.importing.importing.DataImporter(data, context)

Bases: object

identifier = None

name = None

meta_class_getter_name = 'get_import_meta'

meta_base_class

alias of ImportMetaBase

extra_matches = {}

custom_file_transformer = False

unique_fields = {}

unmatched_fields = {}

relation_map_cache = {}

example_files = []

help_template = None

model = None

classmethod get_importer_context(request=None, shop: Shop = None, language: str = None, supplier: Supplier = None, user: User = None, **kwargs)

Returns a context object for the given request that will be used on the importer process.

request parameter is deprecated

Return type:

ImporterContext

__init__(data, context)

classmethod get_permission_identifier()

classmethod transform_file(mode, filename, data=None)

That method will be called if cls.custom_file_transformer is True

process_data()

create_mapping()

map_data_to_fields(model_mapping)

Map fields.

If field is not found it will be saved into unmapped :return:

manually_match(imported_field_name, target_field_name)

do_remap()

matcher(value)

set_extra_match(sess, value, mapping)

do_import(import_mode)

resolve_object(cls, value)

process_row(row)

save_row(new, row_session)

get_fields_for_mapping(only_non_mapped=True)

Get fields for manual mapping.

Returns:

List of fields module_name.Model:field or empty list

Return type:

list

get_related_models()

get_row_model(row)

Get model that matches the row.

Can be used in cases where you have multiple types of data in same import.

Parameters:

row – A row dict.

can_create_object(obj)

Returns whether the importer can create the given object. This is useful to handle related objects creation and skip them when needed.

property is_multi_model

find_matching_model(row)

process_related_value(row_session, field, value, multi, reverse=False)

Process Related values.

Parameters:

field – Django Field object.

Returns:

Found value

classmethod get_help_context_data(request)

Returns the context data that should be used for help texts in admin.

classmethod has_example_file()

classmethod get_example_file(file_name)

:param file_name str :rtype ImporterExampleFile

classmethod get_example_file_content(example_file, request)

Returns a binary file that will be served through the request. This base implementation just renders a template and returns the result as BytesIO or StringIO. Override this method to return a custom file content.

:param request HttpRequest :rtype StringIO|BytesIO

shuup.importer.importing.meta module

class shuup.importer.importing.meta.ImportMetaBase(handler, model)

Bases: object

fk_matchers = {}

aliases = {}

Post save handlers

You can directly assign post save handler for a field. Field That has post save handler assigned won’t be available for mapping and won’t cause it to appear in unmapped fields in importer.

The handler is being triggered if any of the given values in trigger list is being encountered while iterating.

This is a dictionary that contains list of values:

{function_name: [list_of_triggers]}

Example

post_save_handlers = {

“handle_row_address”: [‘city’, ‘country’, ‘postal code’, ‘region code’, ‘street’],

System Message: WARNING/2 (docstring of shuup.importer.importing.meta.ImportMetaBase.aliases, line 17)

Definition list ends without a blank line; unexpected unindent.

}

In this example the handle_row_address is being called when any of the triggers is being encountered.

post_save_handlers = {}

Fields to skip

It’s sometimes necessary to skip fields in importer.

For now we are using this to skip image fields in ProductMetaBase.

fields_to_skip = []

__init__(handler, model)

global_aliases = {}

Aliases for keys usually used in the importing meta

This is dictionary that contains list of values:

{shuup_field: [expected_fields]}

Example

aliases = {

“name_ext”: [“extension”, “ext”]

System Message: WARNING/2 (docstring of shuup.importer.importing.meta.ImportMetaBase.global_aliases, line 10)

Definition list ends without a blank line; unexpected unindent.

}

get_import_defaults()

Get default values for importing

If a certain value is required in import but does not exist in the imported file this method completes said missing data.

Example

return {

“type_id”: ProductType.objects.first().id, “tax_class_id”: TaxClass.objects.first().id,

System Message: WARNING/2 (/home/runner/work/shuup/shuup/shuup/importer/importing/meta.py:docstring of shuup.importer.importing.meta.ImportMetaBase.get_import_defaults, line 11)

Definition list ends without a blank line; unexpected unindent.

}

Returns:

Dict of field name -> default value.

Return type:

dict[str, str]|dict

should_skip_row(row)

Allows you to skip a row from getting imported

Used to set up a condition for a row to get imported

Parameters:

row (dict) – Current row data

Returns:

True if the row should get skipped, False otherwise

Return type:

bool

pre_process_row(row)

Do a pre-processing task on the given row and change the data in place.

This method is called befor the row_session is created to allow to override values on the row or to create related objects.

Parameters:

row (dict) – Current row data

Returns:

the row modified, if needed

Return type:

dict

presave_hook(row_session)

Pre-save Hook

This method is called before the row session is saved. This can be used to add data into row_session.instance

Parameters:

row_session (shuup.importer.importing.session.DataImporterRowSession) – Current row session

Returns:

None

postsave_hook(row_session)

Post-save Hook

This method is called after the row session is saved. This can be used to create related objects.

Parameters:

row_session (shuup.importer.importing.session.DataImporterRowSession) – Current row session

Returns:

None

mutate_normal_field_set(row_session, field, value, original)

has_post_save_handler(field_name)

See if meta has Post-Save handler

Parameters:

field_name – Name of the field to lookup

Returns:

True or False if has post save handler

Return type:

Boolean

property field_aliases

Get all field aliases

If local aliases are being set, global aliases are extended. :return: Dict key => list of aliases :rtype: dict[str, list]|dict

shuup.importer.importing.session module

class shuup.importer.importing.session.DataImporterRowSession(importer, row, instance, shop)

Bases: object

__init__(importer, row, instance, shop)

defer(key, model, using=None)

defer_call(func, *args, **kwargs)

get_deferred(key)

save()

log(message)

Module contents

class shuup.importer.importing.DataImporter(data, context)

Bases: object

__init__(data, context)

can_create_object(obj)

Returns whether the importer can create the given object. This is useful to handle related objects creation and skip them when needed.

create_mapping()

custom_file_transformer = False

do_import(import_mode)

do_remap()

example_files = []

extra_matches = {}

find_matching_model(row)

classmethod get_example_file(file_name)

:param file_name str :rtype ImporterExampleFile

classmethod get_example_file_content(example_file, request)

Returns a binary file that will be served through the request. This base implementation just renders a template and returns the result as BytesIO or StringIO. Override this method to return a custom file content.

:param request HttpRequest :rtype StringIO|BytesIO

get_fields_for_mapping(only_non_mapped=True)

Get fields for manual mapping.

Returns:

List of fields module_name.Model:field or empty list

Return type:

list

classmethod get_help_context_data(request)

Returns the context data that should be used for help texts in admin.

classmethod get_importer_context(request=None, shop: Shop = None, language: str = None, supplier: Supplier = None, user: User = None, **kwargs)

Returns a context object for the given request that will be used on the importer process.

request parameter is deprecated

Return type:

ImporterContext

classmethod get_permission_identifier()

get_related_models()

get_row_model(row)

Get model that matches the row.

Can be used in cases where you have multiple types of data in same import.

Parameters:

row – A row dict.

classmethod has_example_file()

help_template = None

identifier = None

property is_multi_model

manually_match(imported_field_name, target_field_name)

map_data_to_fields(model_mapping)

Map fields.

If field is not found it will be saved into unmapped :return:

matcher(value)

meta_base_class

alias of ImportMetaBase

meta_class_getter_name = 'get_import_meta'

model = None

name = None

process_data()

process_related_value(row_session, field, value, multi, reverse=False)

Process Related values.

Parameters:

field – Django Field object.

Returns:

Found value

process_row(row)

relation_map_cache = {}

resolve_object(cls, value)

save_row(new, row_session)

set_extra_match(sess, value, mapping)

classmethod transform_file(mode, filename, data=None)

That method will be called if cls.custom_file_transformer is True

unique_fields = {}

unmatched_fields = {}

class shuup.importer.importing.DataImporterRowSession(importer, row, instance, shop)

Bases: object

__init__(importer, row, instance, shop)

defer(key, model, using=None)

defer_call(func, *args, **kwargs)

get_deferred(key)

log(message)

save()

class shuup.importer.importing.ImportMetaBase(handler, model)

Bases: object

__init__(handler, model)

aliases = {}

Post save handlers

You can directly assign post save handler for a field. Field That has post save handler assigned won’t be available for mapping and won’t cause it to appear in unmapped fields in importer.

The handler is being triggered if any of the given values in trigger list is being encountered while iterating.

This is a dictionary that contains list of values:

{function_name: [list_of_triggers]}

Example

post_save_handlers = {

“handle_row_address”: [‘city’, ‘country’, ‘postal code’, ‘region code’, ‘street’],

System Message: WARNING/2 (docstring of shuup.importer.importing.ImportMetaBase.aliases, line 17)

Definition list ends without a blank line; unexpected unindent.

}

In this example the handle_row_address is being called when any of the triggers is being encountered.

property field_aliases

Get all field aliases

If local aliases are being set, global aliases are extended. :return: Dict key => list of aliases :rtype: dict[str, list]|dict

fields_to_skip = []

fk_matchers = {}

get_import_defaults()

Get default values for importing

If a certain value is required in import but does not exist in the imported file this method completes said missing data.

Example

return {

“type_id”: ProductType.objects.first().id, “tax_class_id”: TaxClass.objects.first().id,

System Message: WARNING/2 (/home/runner/work/shuup/shuup/shuup/importer/importing/__init__.py:docstring of shuup.importer.importing.meta.ImportMetaBase.get_import_defaults, line 11)

Definition list ends without a blank line; unexpected unindent.

}

Returns:

Dict of field name -> default value.

Return type:

dict[str, str]|dict

global_aliases = {}

Aliases for keys usually used in the importing meta

This is dictionary that contains list of values:

{shuup_field: [expected_fields]}

Example

aliases = {

“name_ext”: [“extension”, “ext”]

System Message: WARNING/2 (docstring of shuup.importer.importing.ImportMetaBase.global_aliases, line 10)

Definition list ends without a blank line; unexpected unindent.

}

has_post_save_handler(field_name)

See if meta has Post-Save handler

Parameters:

field_name – Name of the field to lookup

Returns:

True or False if has post save handler

Return type:

Boolean

mutate_normal_field_set(row_session, field, value, original)

post_save_handlers = {}

Fields to skip

It’s sometimes necessary to skip fields in importer.

For now we are using this to skip image fields in ProductMetaBase.

postsave_hook(row_session)

Post-save Hook

This method is called after the row session is saved. This can be used to create related objects.

Parameters:

row_session (shuup.importer.importing.session.DataImporterRowSession) – Current row session

Returns:

None

pre_process_row(row)

Do a pre-processing task on the given row and change the data in place.

This method is called befor the row_session is created to allow to override values on the row or to create related objects.

Parameters:

row (dict) – Current row data

Returns:

the row modified, if needed

Return type:

dict

presave_hook(row_session)

Pre-save Hook

This method is called before the row session is saved. This can be used to add data into row_session.instance

Parameters:

row_session (shuup.importer.importing.session.DataImporterRowSession) – Current row session

Returns:

None

should_skip_row(row)

Allows you to skip a row from getting imported

Used to set up a condition for a row to get imported

Parameters:

row (dict) – Current row data

Returns:

True if the row should get skipped, False otherwise

Return type:

bool

class shuup.importer.importing.ImporterExampleFile(file_name, content_type, template_name=None)

Bases: object

__init__(file_name, content_type, template_name=None)

content_type = ''

file_name = ''

template_name = ''