magpie.cli.sync_resources

Synchronize local and remote resources.

To implement a new service, see magpie.cli.sync_services.SyncServiceInterface.

See also

• magpie.cli.sync_services

Module Contents

Functions

merge_local_and_remote_resources(resources_local, service_sync_type, service_id, session)	Main function to sync resources with remote server.
_merge_resources(resources_local, resources_remote, max_depth=None)	Merge resources_local and resources_remote, adding the following keys to the output:
_sort_resources(resources)	Sorts a resource dictionary of the type validated by ‘sync_services.is_valid_resource_schema’ by using an
_ensure_sync_info_exists(service_resource_id, session)	Make sure the RemoteResourcesSyncInfo entry exists in the database.
_get_remote_resources(service)	Request remote resources, depending on service type.
_delete_records(service_id, session)	Delete all RemoteResource based on a Service.resource_id.
_create_main_resource(service_id, session)	Creates a main resource for a service, whether one currently exists or not.
_update_db(remote_resources, service_id, session)	Writes remote resources to database.
_format_resource_tree(children)
_query_remote_resources_in_database(service_id, session)	Reads remote resources from the RemoteResources table. No external request is made.
get_last_sync(service_id: int, session: Session) → Optional[datetime.datetime]
fetch_all_services_by_type(service_type, session)	Get remote resources for all services of a certain type.
fetch_single_service(service, session)	Get remote resources for a single service.
fetch(settings=None)	Main function to get all remote resources for each service and write to database.
setup_cron_logger(log_level: Union[AnyStr, int] = logging.INFO) → None
make_parser() → argparse.ArgumentParser
main(args: Optional[Sequence[AnyStr]] = None, parser: Optional[argparse.ArgumentParser] = None, namespace: Optional[argparse.Namespace] = None) → Any	Main entry point for cron service.

magpie.cli.sync_resources.LOGGER

magpie.cli.sync_resources.CRON_SERVICE = False

magpie.cli.sync_resources.OUT_OF_SYNC

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

Main function to sync resources with remote server.

magpie.cli.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.cli.sync_services.is_valid_resource_schema.

magpie.cli.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.cli.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.cli.sync_resources._get_remote_resources(service)

Request remote resources, depending on service type.

Parameters

service – (models.Service)

Returns

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

Delete all RemoteResource based on a Service.resource_id.

Parameters

• service_id –

• session –

magpie.cli.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.cli.sync_resources._update_db(remote_resources, service_id, session)

Writes remote resources to database.

Parameters

• remote_resources –

• service_id –

• session –

magpie.cli.sync_resources._format_resource_tree(children)

magpie.cli.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.cli.sync_resources.get_last_sync(service_id: int, session: Session) → Optional[datetime.datetime]

magpie.cli.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.cli.sync_resources.fetch_single_service(service, session)

Get remote resources for a single service.

Parameters

• service – (models.Service) or service_id

• session –

magpie.cli.sync_resources.fetch(settings=None)

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

magpie.cli.sync_resources.setup_cron_logger(log_level: Union[AnyStr, int] = logging.INFO) → None

magpie.cli.sync_resources.make_parser() → argparse.ArgumentParser

magpie.cli.sync_resources.main(args: Optional[Sequence[AnyStr]] = None, parser: Optional[argparse.ArgumentParser] = None, namespace: Optional[argparse.Namespace] = None) → Any

Main entry point for cron service.