magpie.api.management.register.register_formats

Module Contents

Functions

format_pending_user(→ magpie.typedefs.JSON)

Formats a Pending User information into JSON.
magpie.api.management.register.register_formats.format_pending_user(user: magpie.models.UserPending, basic_info: bool = False, dotted: bool = False, container: magpie.typedefs.AnySettingsContainer | None = None) → magpie.typedefs.JSON[source]

Formats a Pending User information into JSON.

Parameters:

  • user – Pending User to be formatted.

  • basic_info – If True, return only sufficient details to identify the Pending User registration.

  • dotted – Employ a dot (.) instead of underscore (_) to separate Pending User from its basic information.

  • container – application settings container used to retrieve more metadata about the Pending User.