Toggle navigation

.rst .pdf

Contents

ucsschool.importer package

Subpackages

• ucsschool.importer.contrib package
  • Submodules
  • ucsschool.importer.contrib.csv module
• ucsschool.importer.frontend package
  • Submodules
  • ucsschool.importer.frontend.cmdline module
  • ucsschool.importer.frontend.parse_user_import_cmdline module
  • ucsschool.importer.frontend.user_import_cmdline module
• ucsschool.importer.mass_import package
  • Submodules
  • ucsschool.importer.mass_import.mass_import module
  • ucsschool.importer.mass_import.sisopi_user_import module
  • ucsschool.importer.mass_import.user_import module
• ucsschool.importer.models package
  • Submodules
  • ucsschool.importer.models.import_user module
• ucsschool.importer.reader package
  • Submodules
  • ucsschool.importer.reader.base_reader module
  • ucsschool.importer.reader.csv_reader module
  • ucsschool.importer.reader.http_api_csv_reader module
  • ucsschool.importer.reader.test_csv_reader module
• ucsschool.importer.utils package
  • Submodules
  • ucsschool.importer.utils.config_pyhook module
  • ucsschool.importer.utils.configuration_checks module
  • ucsschool.importer.utils.format_pyhook module
  • ucsschool.importer.utils.import_pyhook module
  • ucsschool.importer.utils.ldap_connection module
  • ucsschool.importer.utils.logging module
  • ucsschool.importer.utils.post_read_pyhook module
  • ucsschool.importer.utils.pre_read_pyhook module
  • ucsschool.importer.utils.result_pyhook module
  • ucsschool.importer.utils.test_user_creator module
  • ucsschool.importer.utils.user_pyhook module
  • ucsschool.importer.utils.username_handler module
  • ucsschool.importer.utils.utils module
• ucsschool.importer.writer package
  • Submodules
  • ucsschool.importer.writer.base_writer module
  • ucsschool.importer.writer.csv_writer module
  • ucsschool.importer.writer.new_user_password_csv_exporter module
  • ucsschool.importer.writer.result_exporter module
  • ucsschool.importer.writer.test_user_csv_exporter module
  • ucsschool.importer.writer.user_import_csv_result_exporter module

Submodules

ucsschool.importer.configuration module

ucsschool.importer.default_user_import_factory module

ucsschool.importer.exceptions module

All exceptions raised by code in ucsschool.importer.

exception ucsschool.importer.exceptions.UcsSchoolImportError(*args, **kwargs)

Bases: Exception

is_fatal = False

is_countable = True

exception ucsschool.importer.exceptions.UcsSchoolImportFatalError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

is_fatal = True

exception ucsschool.importer.exceptions.UcsSchoolImportSkipImportRecord(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

is_countable = False

exception ucsschool.importer.exceptions.BadPassword(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.BadValueStored(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportFatalError

exception ucsschool.importer.exceptions.ConfigurationError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportFatalError

exception ucsschool.importer.exceptions.CreationError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.DeletionError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.FormatError(msg, scheme, data, *args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.EmptyFormatResultError(msg, scheme, data, *args, **kwargs)

Bases: ucsschool.importer.exceptions.FormatError

exception ucsschool.importer.exceptions.EmptyMandatoryAttribute(msg, attr_name, *args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.InitialisationError(msg, log_traceback=True, *args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportFatalError

exception ucsschool.importer.exceptions.InvalidBirthday(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.InvalidClassName(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.InvalidEmail(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.InvalidSchoolClasses(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.InvalidSchools(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.LDAPWriteAccessDenied(msg=None, *args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportFatalError

exception ucsschool.importer.exceptions.MissingMandatoryAttribute(msg, mandatory_attributes, *args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.MissingMailDomain(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.MissingSchoolName(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.MissingUid(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.ModificationError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.MoveError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.NameKeyExists(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportFatalError

exception ucsschool.importer.exceptions.NoRole(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.NotSupportedError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.NoUsernameAtAll(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportFatalError

exception ucsschool.importer.exceptions.NoValueStored(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportFatalError

exception ucsschool.importer.exceptions.ReadOnlyConfiguration(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportFatalError

exception ucsschool.importer.exceptions.TooManyErrors(msg, errors, *args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportFatalError

exception ucsschool.importer.exceptions.UDMError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.UDMValueError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UDMError

exception ucsschool.importer.exceptions.UnknownAction(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.UnknownDisabledSetting(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.UnknownProperty(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.UnknownRole(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.UnknownSchoolName(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.UniqueIdError(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.UsernameToLong(*args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

exception ucsschool.importer.exceptions.UserValidationError(msg, validation_error, *args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

Wraps ucsschool.lib.models.attributes.ValidationError

exception ucsschool.importer.exceptions.WrongUserType(msg, *args, **kwargs)

Bases: ucsschool.importer.exceptions.UcsSchoolImportError

Wraps ucsschool.lib.models.base.WrongObjectType

ucsschool.importer.factory module

Singleton to the factory currently in use.

ucsschool.importer.factory.setup_factory(factory_cls_name)

Create import factory.

Parameters

factory_cls_name (str) – full dotted name of class

Returns

Factory object

Return type

Factory

ucsschool.importer.factory.load_class(dotted_class_name)

Load class from its full dotted name.

Parameters

dotted_class_name – str: full dotted name of class

Returns

class

Return type

type

class ucsschool.importer.factory.Factory(factory=None)

Bases: object

Singleton to the global abstract factory object.

previous

ucsschool.http_api.import_api.migrations package

next

ucsschool.importer.contrib package