ocrd_network package¶
Subpackages¶
- ocrd_network.cli package
- ocrd_network.models package
DBProcessorJobDBProcessorJob.job_idDBProcessorJob.processor_nameDBProcessorJob.path_to_metsDBProcessorJob.workspace_idDBProcessorJob.descriptionDBProcessorJob.stateDBProcessorJob.input_file_grpsDBProcessorJob.output_file_grpsDBProcessorJob.page_idDBProcessorJob.parametersDBProcessorJob.depends_onDBProcessorJob.result_queue_nameDBProcessorJob.callback_urlDBProcessorJob.internal_callback_urlDBProcessorJob.start_timeDBProcessorJob.end_timeDBProcessorJob.exec_timeDBProcessorJob.log_file_pathDBProcessorJob.SettingsDBProcessorJob.to_job_output()
DBWorkflowJobDBWorkspaceDBWorkflowScriptPYJobInputPYJobInput.processor_namePYJobInput.path_to_metsPYJobInput.workspace_idPYJobInput.descriptionPYJobInput.input_file_grpsPYJobInput.output_file_grpsPYJobInput.page_idPYJobInput.parametersPYJobInput.result_queue_namePYJobInput.callback_urlPYJobInput.agent_typePYJobInput.job_idPYJobInput.depends_onPYJobInput.Config
PYJobOutputPYOcrdToolPYResultMessagePYWorkflowJobOutput- Submodules
- ocrd_network.rabbitmq_utils package
check_if_queue_exists()connect_rabbitmq_consumer()connect_rabbitmq_publisher()create_message_queues()verify_and_parse_mq_uri()verify_rabbitmq_available()RMQConsumerRMQConnectorRMQConnector.close_connection()RMQConnector.declare_and_bind_defaults()RMQConnector.open_blocking_connection()RMQConnector.open_blocking_channel()RMQConnector.exchange_bind()RMQConnector.exchange_declare()RMQConnector.exchange_delete()RMQConnector.exchange_unbind()RMQConnector.queue_bind()RMQConnector.queue_declare()RMQConnector.queue_delete()RMQConnector.queue_purge()RMQConnector.queue_unbind()RMQConnector.create_queue()RMQConnector.set_qos()RMQConnector.confirm_delivery()RMQConnector.basic_publish()
RMQPublisherOcrdProcessingMessageOcrdResultMessage- Submodules
- ocrd_network.runtime_data package
DeployerDeployer.find_matching_network_agents()Deployer.resolve_processor_server_url()Deployer.deploy_network_agents()Deployer.stop_network_agents()Deployer.deploy_rabbitmq()Deployer.stop_rabbitmq()Deployer.deploy_mongodb()Deployer.stop_mongodb()Deployer.stop_all()Deployer.start_uds_mets_server()Deployer.stop_uds_mets_server()
DataHostDataMongoDBDataNetworkAgentDataRabbitMQDataProcessingWorkerDataProcessorServer- Submodules
Submodules¶
- ocrd_network.client module
- ocrd_network.client_utils module
poll_job_status_till_timeout_fail_or_success()poll_wf_status_till_timeout_fail_or_success()get_ps_deployed_processors()get_ps_deployed_processor_ocrd_tool()get_ps_processing_job_log()get_ps_processing_job_status()get_ps_workflow_job_status()post_ps_processing_request()post_ps_workflow_request()verify_server_protocol()
- ocrd_network.constants module
- ocrd_network.database module
initiate_database()sync_initiate_database()db_create_workspace()sync_db_create_workspace()db_get_workspace()sync_db_get_workspace()db_update_workspace()sync_db_update_workspace()db_create_processing_job()sync_db_create_processing_job()db_get_processing_job()sync_db_get_processing_job()db_update_processing_job()sync_db_update_processing_job()db_create_workflow_job()sync_db_create_workflow_job()db_get_workflow_job()sync_db_get_workflow_job()db_get_processing_jobs()sync_db_get_processing_jobs()db_create_workflow_script()sync_db_create_workflow_script()db_get_workflow_script()sync_db_get_workflow_script()db_find_first_workflow_script_by_content()sync_db_find_first_workflow_script_by_content()verify_database_uri()verify_mongodb_available()
- ocrd_network.logging_utils module
configure_file_handler_with_formatter()get_root_logging_dir()get_cache_locked_pages_logging_file_path()get_cache_processing_requests_logging_file_path()get_mets_server_logging_file_path()get_processing_job_logging_file_path()get_processing_server_logging_file_path()get_processing_worker_logging_file_path()get_processor_server_logging_file_path()
- ocrd_network.param_validators module
- ocrd_network.process_helpers module
- ocrd_network.processing_server module
ProcessingServerProcessingServer.start()ProcessingServer.on_startup()ProcessingServer.on_shutdown()ProcessingServer.add_api_routes_others()ProcessingServer.add_api_routes_processing()ProcessingServer.add_api_routes_workflow()ProcessingServer.forward_tcp_request_to_uds_mets_server()ProcessingServer.home_page()ProcessingServer.stop_deployed_agents()ProcessingServer.query_ocrd_tool_json_from_server()ProcessingServer.get_network_agent_ocrd_tool()ProcessingServer.network_agent_exists_server()ProcessingServer.network_agent_exists_worker()ProcessingServer.validate_agent_type_and_existence()ProcessingServer.validate_and_forward_job_to_network_agent()ProcessingServer.push_job_to_network_agent()ProcessingServer.push_job_to_processing_queue()ProcessingServer.push_job_to_processor_server()ProcessingServer.get_processor_job()ProcessingServer.get_processor_job_log()ProcessingServer.push_cached_jobs_to_agents()ProcessingServer.remove_job_from_request_cache()ProcessingServer.list_processors()ProcessingServer.task_sequence_to_processing_jobs()ProcessingServer.validate_tasks_agents_existence()ProcessingServer.run_workflow()ProcessingServer.get_workflow_info()ProcessingServer.kill_mets_server_zombies()ProcessingServer.get_workflow_info_simple()ProcessingServer.upload_workflow()ProcessingServer.replace_workflow()ProcessingServer.download_workflow()
- ocrd_network.processing_worker module
- ocrd_network.processor_server module
ProcessorServerProcessorServer.on_startup()ProcessorServer.on_shutdown()ProcessorServer.add_api_routes_processing()ProcessorServer.get_processor_info()ProcessorServer.create_processor_task()ProcessorServer.run_processor_task()ProcessorServer.get_ocrd_tool()ProcessorServer.get_version()ProcessorServer.run_server()ProcessorServer.get_processor_job()ProcessorServer.get_processor_job_log()
- ocrd_network.server_cache module
CacheLockedPagesCacheProcessingRequestsCacheProcessingRequests.consume_cached_requests()CacheProcessingRequests.sync_consume_cached_requests()CacheProcessingRequests.update_request_counter()CacheProcessingRequests.cache_request()CacheProcessingRequests.cancel_dependent_jobs()CacheProcessingRequests.sync_cancel_dependent_jobs()CacheProcessingRequests.is_caching_required()CacheProcessingRequests.sync_is_caching_required()CacheProcessingRequests.has_workspace_cached_requests()
- ocrd_network.server_utils module
create_processing_message()create_workspace_if_not_exists()get_from_database_workflow_job()get_from_database_workspace()get_page_ids_list()request_processor_server_tool_json()forward_job_to_processor_server()get_workflow_content()validate_and_return_mets_path()parse_workflow_tasks()raise_http_exception()validate_job_input()validate_workflow()validate_first_task_input_file_groups_existence()kill_mets_server_zombies()
- ocrd_network.tcp_to_uds_mets_proxy module
- ocrd_network.utils module
call_sync()calculate_execution_time()calculate_processing_request_timeout()convert_url_to_uds_format()expand_page_ids()generate_created_time()generate_id()generate_workflow_content()generate_workflow_content_hash()is_url_responsive()load_ocrd_all_tool_json()post_to_callback_url()get_ocrd_workspace_instance()get_ocrd_workspace_physical_pages()is_mets_server_running()stop_mets_server()get_uds_path()
