magpie.helpers.sync_resources

Synchronize local and remote resources.

To implement a new service, see the _SyncServiceInterface class.

Module Contents

magpie.helpers.sync_resources.LOGGER

magpie.helpers.sync_resources.CRON_SERVICE = False

magpie.helpers.sync_resources.OUT_OF_SYNC

magpie.helpers.sync_resources.merge_local_and_remote_resources(resources_local, service_sync_type, service_id, session)

Main function to sync resources with remote server.

magpie.helpers.sync_resources._merge_resources(resources_local, resources_remote, max_depth=None)

Merge resources_local and resources_remote, adding the following keys to the output:

• remote_id: id of the RemoteResource
• matches_remote: True or False depending if the resource is present on the remote server

Returns:dictionary of the form validated by magpie.helpers.sync_services.is_valid_resource_schema.

magpie.helpers.sync_resources._sort_resources(resources)

Sorts a resource dictionary of the type validated by ‘sync_services.is_valid_resource_schema’ by using an OrderedDict.

Returns:None

magpie.helpers.sync_resources._ensure_sync_info_exists(service_resource_id, session)

Make sure the RemoteResourcesSyncInfo entry exists in the database.

Parameters:

• service_resource_id –
• session –

magpie.helpers.sync_resources._get_remote_resources(service)

Request remote resources, depending on service type.

Parameters:service – (models.Service) Returns:

magpie.helpers.sync_resources._delete_records(service_id, session)

Delete all RemoteResource based on a Service.resource_id.

Parameters:

• service_id –
• session –

magpie.helpers.sync_resources._create_main_resource(service_id, session)

Creates a main resource for a service, whether one currently exists or not.

Each RemoteResourcesSyncInfo has a main RemoteResource of the same name as the service. This is similar to the Service and Resource relationship.

Parameters:

• service_id –
• session –

magpie.helpers.sync_resources._update_db(remote_resources, service_id, session)

Writes remote resources to database.

Parameters:

• remote_resources –
• service_id –
• session –

magpie.helpers.sync_resources._get_resource_children(resource, db_session)

Mostly copied from ziggurat_foundations to use RemoteResource instead of Resource.

Parameters:

• resource –
• db_session –

Returns:

magpie.helpers.sync_resources._format_resource_tree(children)

magpie.helpers.sync_resources._query_remote_resources_in_database(service_id, session)

Reads remote resources from the RemoteResources table. No external request is made.

Returns:a dictionary of the form defined in ‘sync_services.is_valid_resource_schema’

magpie.helpers.sync_resources.get_last_sync(service_id, session) → Optional[datetime.datetime]

magpie.helpers.sync_resources.fetch_all_services_by_type(service_type, session)

Get remote resources for all services of a certain type.

Parameters:

• service_type –
• session –

magpie.helpers.sync_resources.fetch_single_service(service, session)

Get remote resources for a single service.

Parameters:

• service – (models.Service) or service_id
• session –

magpie.helpers.sync_resources.fetch()

Main function to get all remote resources for each service and write to database.

magpie.helpers.sync_resources.setup_cron_logger()

magpie.helpers.sync_resources.main()

Main entry point for cron service.