decisionengine.framework package

Subpackages

• decisionengine.framework.config package
  • Subpackages
    • decisionengine.framework.config.tests package
      • Submodules
      • decisionengine.framework.config.tests.test_config module
      • decisionengine.framework.config.tests.test_de_std module
      • decisionengine.framework.config.tests.test_policies module
      • Module contents
  • Submodules
  • decisionengine.framework.config.ChannelConfigHandler module
    • ChannelConfigHandler
      • ChannelConfigHandler._load_channel()
      • ChannelConfigHandler.get_channels()
      • ChannelConfigHandler.load_all_channels()
      • ChannelConfigHandler.load_channel()
      • ChannelConfigHandler.print_channel_config()
    • _check_keys()
    • _make_de_logger()
  • decisionengine.framework.config.ValidConfig module
    • ValidConfig
      • ValidConfig._abc_impl
      • ValidConfig.dump()
    • _config_from_file()
  • decisionengine.framework.config.policies module
    • channel_config_dir()
    • global_config_dir()
    • global_config_file()
    • valid_dir()
  • Module contents
• decisionengine.framework.dataspace package
  • Subpackages
    • decisionengine.framework.dataspace.datasources package
      • Subpackages
      • Submodules
      • decisionengine.framework.dataspace.datasources.null module
      • Module contents
    • decisionengine.framework.dataspace.tests package
      • Submodules
      • decisionengine.framework.dataspace.tests.fixtures module
      • decisionengine.framework.dataspace.tests.test_Reaper module
      • decisionengine.framework.dataspace.tests.test_datablock module
      • decisionengine.framework.dataspace.tests.test_datablock_zlib module
      • decisionengine.framework.dataspace.tests.test_datasource module
      • decisionengine.framework.dataspace.tests.test_dataspace module
      • Module contents
  • Submodules
  • decisionengine.framework.dataspace.datablock module
    • DataBlock
      • DataBlock.__insert()
      • DataBlock.__update()
      • DataBlock._setitem()
      • DataBlock.duplicate()
      • DataBlock.get()
      • DataBlock.get_dataproducts()
      • DataBlock.get_header()
      • DataBlock.get_metadata()
      • DataBlock.get_taskmanager()
      • DataBlock.is_expired()
      • DataBlock.keys()
      • DataBlock.mark_expired()
      • DataBlock.put()
      • DataBlock.store_taskmanager()
    • Header
      • Header._abc_impl
      • Header.default_data_lifetime
      • Header.is_valid()
      • Header.required_keys
    • InvalidMetadataError
    • Metadata
      • Metadata._abc_impl
      • Metadata.required_keys
      • Metadata.set_state()
      • Metadata.valid_states
    • ProductRetriever
    • compress()
    • decompress()
    • zdumps()
    • zloads()
  • decisionengine.framework.dataspace.datasource module
    • DataSource
      • DataSource._abc_impl
      • DataSource.close()
      • DataSource.connect()
      • DataSource.create_tables()
      • DataSource.dataproduct_table
      • DataSource.delete_data_older_than()
      • DataSource.duplicate_datablock()
      • DataSource.get_datablock()
      • DataSource.get_dataproduct()
      • DataSource.get_dataproducts()
      • DataSource.get_header()
      • DataSource.get_last_generation_id()
      • DataSource.get_metadata()
      • DataSource.get_schema()
      • DataSource.get_taskmanager()
      • DataSource.get_taskmanagers()
      • DataSource.header_table
      • DataSource.insert()
      • DataSource.metadata_table
      • DataSource.reset_connections()
      • DataSource.store_taskmanager()
      • DataSource.taskmanager_table
      • DataSource.update()
  • decisionengine.framework.dataspace.dataspace module
    • DataSpace
      • DataSpace.close()
      • DataSpace.delete()
      • DataSpace.duplicate_datablock()
      • DataSpace.get_datablock()
      • DataSpace.get_dataproduct()
      • DataSpace.get_dataproducts()
      • DataSpace.get_header()
      • DataSpace.get_last_generation_id()
      • DataSpace.get_metadata()
      • DataSpace.get_taskmanager()
      • DataSpace.get_taskmanagers()
      • DataSpace.insert()
      • DataSpace.mark_demented()
      • DataSpace.mark_expired()
      • DataSpace.store_taskmanager()
      • DataSpace.update()
    • DataSpaceConfigurationError
    • DataSpaceConnectionError
    • DataSpaceError
    • DataSpaceExistsError
  • decisionengine.framework.dataspace.maintain module
    • Reaper
      • Reaper.MIN_RETENTION_INTERVAL_DAYS
      • Reaper.MIN_SECONDS_BETWEEN_RUNS
      • Reaper._reaper_loop()
      • Reaper.reap()
      • Reaper.retention_interval
      • Reaper.seconds_between_runs
      • Reaper.start()
      • Reaper.stop()
  • Module contents
• decisionengine.framework.engine package
  • Subpackages
    • decisionengine.framework.engine.tests package
      • Submodules
      • decisionengine.framework.engine.tests.conftest module
      • decisionengine.framework.engine.tests.fixtures module
      • decisionengine.framework.engine.tests.test_ChannelWorkers module
      • decisionengine.framework.engine.tests.test_SourceWorkers module
      • decisionengine.framework.engine.tests.test_client_only module
      • decisionengine.framework.engine.tests.test_query_tool_only module
      • decisionengine.framework.engine.tests.test_startup module
      • decisionengine.framework.engine.tests.test_verify_redis_server module
      • Module contents
  • Submodules
  • decisionengine.framework.engine.ChannelWorkers module
    • ChannelWorker
      • ChannelWorker.get_consumes()
      • ChannelWorker.get_produces()
      • ChannelWorker.get_state_name()
      • ChannelWorker.run()
      • ChannelWorker.setup_logger()
      • ChannelWorker.wait_while()
    • ChannelWorkers
      • ChannelWorkers.Access
      • ChannelWorkers.access()
      • ChannelWorkers.accessed_by_another_thread()
      • ChannelWorkers.get_unguarded()
  • decisionengine.framework.engine.ClientMessageReceiver module
    • ClientMessageReceiver
      • ClientMessageReceiver._receive()
      • ClientMessageReceiver.execute()
  • decisionengine.framework.engine.DecisionEngine module
    • DecisionEngine
      • DecisionEngine._dataframe_to_column_names()
      • DecisionEngine._dataframe_to_csv()
      • DecisionEngine._dataframe_to_json()
      • DecisionEngine._dataframe_to_table()
      • DecisionEngine._dataframe_to_vertical_tables()
      • DecisionEngine._dispatch()
      • DecisionEngine.block_while()
      • DecisionEngine.create_channel()
      • DecisionEngine.get_logger()
      • DecisionEngine.metrics()
      • DecisionEngine.reaper_start()
      • DecisionEngine.reaper_status()
      • DecisionEngine.reaper_stop()
      • DecisionEngine.rm_channel()
      • DecisionEngine.rpc_block_while()
      • DecisionEngine.rpc_get_channel_log_level()
      • DecisionEngine.rpc_get_log_level()
      • DecisionEngine.rpc_get_source_log_level()
      • DecisionEngine.rpc_kill_channel()
      • DecisionEngine.rpc_metrics()
      • DecisionEngine.rpc_ping()
      • DecisionEngine.rpc_print_product()
      • DecisionEngine.rpc_print_products()
      • DecisionEngine.rpc_product_dependencies()
      • DecisionEngine.rpc_query_tool()
      • DecisionEngine.rpc_queue_status()
      • DecisionEngine.rpc_reaper_start()
      • DecisionEngine.rpc_reaper_status()
      • DecisionEngine.rpc_reaper_stop()
      • DecisionEngine.rpc_rm_channel()
      • DecisionEngine.rpc_set_channel_log_level()
      • DecisionEngine.rpc_set_source_log_level()
      • DecisionEngine.rpc_show_config()
      • DecisionEngine.rpc_show_de_config()
      • DecisionEngine.rpc_start_channel()
      • DecisionEngine.rpc_start_channels()
      • DecisionEngine.rpc_status()
      • DecisionEngine.rpc_stop()
      • DecisionEngine.rpc_stop_channel()
      • DecisionEngine.rpc_stop_channels()
      • DecisionEngine.service_actions()
      • DecisionEngine.start_channel()
      • DecisionEngine.start_channels()
      • DecisionEngine.start_webserver()
      • DecisionEngine.stop_channels()
      • DecisionEngine.stop_worker()
    • RequestHandler
      • RequestHandler.rpc_paths
    • StopState
      • StopState.Clean
      • StopState.NotFound
      • StopState.Terminated
    • _channel_preamble()
    • _check_metrics_env()
    • _create_de_server()
    • _get_de_conf_manager()
    • _get_global_config()
    • _initial_start_channels()
    • _queue_name_and_type()
    • _requests_in_flight()
    • _start_de_server()
    • _verify_redis_server()
    • _verify_redis_url()
    • main()
    • parse_program_options()
  • decisionengine.framework.engine.SourceWorkers module
    • SourceWorker
      • SourceWorker.get_loglevel()
      • SourceWorker.run()
      • SourceWorker.set_loglevel_value()
      • SourceWorker.setup_logger()
      • SourceWorker.take_offline()
    • SourceWorkers
      • SourceWorkers.Access
      • SourceWorkers.access()
      • SourceWorkers.detach()
      • SourceWorkers.get_unguarded()
      • SourceWorkers.prune()
      • SourceWorkers.remove_all()
      • SourceWorkers.update()
  • decisionengine.framework.engine.de_client module
    • command_for_args()
    • console_scripts_main()
    • create_parser()
    • main()
  • decisionengine.framework.engine.de_query_tool module
    • command_for_args()
    • console_scripts_main()
    • create_parser()
    • main()
  • Module contents
• decisionengine.framework.logicengine package
  • Subpackages
    • decisionengine.framework.logicengine.tests package
      • Submodules
      • decisionengine.framework.logicengine.tests.test_bool_function_name module
      • decisionengine.framework.logicengine.tests.test_cascaded_rules module
      • decisionengine.framework.logicengine.tests.test_construction module
      • decisionengine.framework.logicengine.tests.test_duplicate_fact_names module
      • decisionengine.framework.logicengine.tests.test_facts module
      • decisionengine.framework.logicengine.tests.test_fail_on_error module
      • decisionengine.framework.logicengine.tests.test_pandas_fact module
      • decisionengine.framework.logicengine.tests.test_rule_with_negated_fact module
      • decisionengine.framework.logicengine.tests.test_simple_configuration module
      • Module contents
  • Submodules
  • decisionengine.framework.logicengine.BooleanExpression module
    • BooleanExpression
      • BooleanExpression.evaluate()
    • LogicError
    • function_name_from_call()
    • maybe_fail_on_error()
  • decisionengine.framework.logicengine.FactLookup module
    • FactLookup
      • FactLookup.rule_for()
      • FactLookup.sorted_rules()
  • decisionengine.framework.logicengine.LogicEngine module
    • LogicEngine
      • LogicEngine._create_facts_dataframe()
      • LogicEngine.consumes()
      • LogicEngine.evaluate()
      • LogicEngine.evaluate_facts()
      • LogicEngine.produces()
    • passthrough_configuration()
  • decisionengine.framework.logicengine.Rule module
    • Rule
      • Rule.evaluate()
  • decisionengine.framework.logicengine.RuleEngine module
    • RuleEngine
      • RuleEngine.execute()
  • Module contents
• decisionengine.framework.modules package
  • Subpackages
    • decisionengine.framework.modules.tests package
      • Submodules
      • decisionengine.framework.modules.tests.test_EmptySource module
      • decisionengine.framework.modules.tests.test_Module module
      • decisionengine.framework.modules.tests.test_Publisher module
      • decisionengine.framework.modules.tests.test_QueueLogger module
      • decisionengine.framework.modules.tests.test_Source module
      • decisionengine.framework.modules.tests.test_Transform module
      • decisionengine.framework.modules.tests.test_de_logger module
      • decisionengine.framework.modules.tests.test_module_decorators module
      • decisionengine.framework.modules.tests.test_translate_product_name module
      • Module contents
  • Submodules
  • decisionengine.framework.modules.EmptySource module
    • EmptySource
      • EmptySource._supported_config
      • EmptySource.acquire()
  • decisionengine.framework.modules.Module module
    • Module
      • Module.get_data_block()
      • Module.get_parameters()
      • Module.set_data_block()
    • consumes()
    • produces()
    • verify_products()
  • decisionengine.framework.modules.Publisher module
    • Parameter
    • Publisher
      • Publisher._consumes
      • Publisher.publish()
      • Publisher.shutdown()
    • consumes()
    • describe()
    • supports_config()
  • decisionengine.framework.modules.QueueLogger module
    • QueueLogger
      • QueueLogger.configure_listener()
      • QueueLogger.format_logger()
      • QueueLogger.initialize_q()
      • QueueLogger.setup_queue_logging()
      • QueueLogger.start()
      • QueueLogger.stop()
  • decisionengine.framework.modules.Source module
    • Parameter
    • Source
      • Source._produces
      • Source.acquire()
    • describe()
    • produces()
    • supports_config()
  • decisionengine.framework.modules.Transform module
    • Parameter
    • Transform
      • Transform._consumes
      • Transform._produces
      • Transform.transform()
    • consumes()
    • describe()
    • produces()
    • supports_config()
  • decisionengine.framework.modules.de_logger module
    • configure_logging()
    • get_logger()
    • get_queue_logger()
    • stop_queue_logger()
  • decisionengine.framework.modules.describe module
    • ModuleProgramOptions
      • ModuleProgramOptions.process_args()
    • Parameter
    • _par_default()
    • _par_type()
    • main_wrapper()
    • supports_config()
  • decisionengine.framework.modules.logging_configDict module
  • decisionengine.framework.modules.print_description module
    • _print_comment()
    • _print_type()
    • _print_value()
    • _spec_from_file_name()
    • print_consumes()
    • print_produces()
    • print_supported_config()
    • spec_if_main()
  • decisionengine.framework.modules.translate_product_name module
    • translate()
    • translate_all()
  • Module contents
• decisionengine.framework.taskmanager package
  • Submodules
  • decisionengine.framework.taskmanager.LatestMessages module
    • LatestMessages
      • LatestMessages._listen()
      • LatestMessages.consume()
  • decisionengine.framework.taskmanager.ProcessingState module
    • ProcessingState
      • ProcessingState.get()
      • ProcessingState.get_state_value()
      • ProcessingState.has_value()
      • ProcessingState.inactive()
      • ProcessingState.lock
      • ProcessingState.probably_running()
      • ProcessingState.set()
      • ProcessingState.should_stop()
      • ProcessingState.wait_until()
      • ProcessingState.wait_while()
    • State
      • State.ACTIVE
      • State.BOOT
      • State.ERROR
      • State.IDLE
      • State.OFFLINE
      • State.SHUTDOWN
      • State.SHUTTINGDOWN
      • State.STEADY
  • decisionengine.framework.taskmanager.PublisherStatus module
    • PublisherState
      • PublisherState._asdict()
      • PublisherState._field_defaults
      • PublisherState._fields
      • PublisherState._make()
      • PublisherState._replace()
      • PublisherState.duration
      • PublisherState.enabled
      • PublisherState.since
    • PublisherStatus
      • PublisherStatus.is_enabled()
      • PublisherStatus.state()
    • PublisherStatusBoard
      • PublisherStatusBoard.snapshot()
      • PublisherStatusBoard.update()
  • decisionengine.framework.taskmanager.SourceProductCache module
    • SourceProductCache
      • SourceProductCache.update()
  • decisionengine.framework.taskmanager.TaskManager module
    • TaskManager
      • TaskManager.data_block_put()
      • TaskManager.decision_cycle()
      • TaskManager.get_consumes()
      • TaskManager.get_loglevel()
      • TaskManager.get_produces()
      • TaskManager.get_state()
      • TaskManager.get_state_name()
      • TaskManager.get_state_value()
      • TaskManager.run_cycle()
      • TaskManager.run_cycles()
      • TaskManager.run_logic_engine()
      • TaskManager.run_publishers()
      • TaskManager.run_transform()
      • TaskManager.run_transforms()
      • TaskManager.set_loglevel_value()
      • TaskManager.take_offline()
  • decisionengine.framework.taskmanager.module_graph module
    • Worker
    • _consumed_products()
    • _create_module_instance()
    • _find_only_one_subclass()
    • _make_workers_for()
    • _produced_products()
    • channel_workers()
    • ensure_no_circularities()
    • source_products()
    • validated_workflow()
  • Module contents
• decisionengine.framework.tests package
  • Submodules
  • decisionengine.framework.tests.ABTransform module
    • ABTransform
      • ABTransform._consumes
      • ABTransform._produces
  • decisionengine.framework.tests.BATransform module
    • BATransform
      • BATransform._consumes
      • BATransform._produces
  • decisionengine.framework.tests.DynamicPublisher module
    • DynamicPublisher
      • DynamicPublisher._supported_config
      • DynamicPublisher.publisher()
  • decisionengine.framework.tests.DynamicSource module
    • DynamicSource
      • DynamicSource._supported_config
      • DynamicSource.acquire()
  • decisionengine.framework.tests.DynamicTransform module
    • DynamicTransform
      • DynamicTransform._supported_config
      • DynamicTransform.transform()
  • decisionengine.framework.tests.ErringPublisher module
    • ErringPublisher
      • ErringPublisher._consumes
      • ErringPublisher.publish()
  • decisionengine.framework.tests.ErrorOnAcquire module
    • ErrorOnAcquire
      • ErrorOnAcquire._produces
      • ErrorOnAcquire.acquire()
  • decisionengine.framework.tests.FailingPublisher module
    • FailingPublisher
      • FailingPublisher._consumes
      • FailingPublisher.publish()
  • decisionengine.framework.tests.IntSource module
    • IntSource
      • IntSource._produces
      • IntSource._supported_config
      • IntSource.acquire()
  • decisionengine.framework.tests.ModuleProgramOptions module
    • AcquireWithConfig
      • AcquireWithConfig.test()
    • AcquireWithSampleConfig
      • AcquireWithSampleConfig.test()
    • ConfigTemplate
      • ConfigTemplate.test()
    • Describe
      • Describe.test()
    • DescribeAlias
      • DescribeAlias.test()
    • Help
      • Help.test()
    • _expected_acquire_result()
    • _expected_config_template()
    • _expected_config_template_with_comments()
    • _expected_help()
    • _expected_source_help()
    • _normalize()
    • _run_as_main()
  • decisionengine.framework.tests.PublisherNOP module
    • PublisherNOP
      • PublisherNOP._consumes
      • PublisherNOP.publish()
  • decisionengine.framework.tests.PublisherWithMissingConsumes module
    • PublisherWithMissingConsumes
  • decisionengine.framework.tests.SourceAlias module
  • decisionengine.framework.tests.SourceNOP module
    • SourceNOP
      • SourceNOP._produces
      • SourceNOP.acquire()
  • decisionengine.framework.tests.SourceWithMissingProduces module
    • SourceWithMissingProduces
  • decisionengine.framework.tests.SourceWithSampleConfigNOP module
    • SourceWithSampleConfigNOP
      • SourceWithSampleConfigNOP._produces
      • SourceWithSampleConfigNOP._supported_config
      • SourceWithSampleConfigNOP.acquire()
  • decisionengine.framework.tests.SupportsConfigPublisher module
    • SupportsConfig
      • SupportsConfig._supported_config
  • decisionengine.framework.tests.TransformNOP module
    • TransformNOP
      • TransformNOP._consumes
      • TransformNOP._produces
      • TransformNOP.transform()
  • decisionengine.framework.tests.TransformWithMissingProducesConsumes module
    • TransformWithMissingProducesConsumes
      • TransformWithMissingProducesConsumes.transform()
  • decisionengine.framework.tests.WriteToDisk module
    • WriteToDisk
      • WriteToDisk._supported_config
      • WriteToDisk.publish()
    • wait_for_n_writes()
  • decisionengine.framework.tests.fixtures module
    • DEServer()
    • PG_DE_DB_WITHOUT_SCHEMA()
    • PG_PROG()
    • SQLALCHEMY_PG_WITH_SCHEMA()
    • SQLALCHEMY_TEMPFILE_SQLITE()
  • decisionengine.framework.tests.test_client_errors module
    • test_client_cannot_wait_on_bad_state()
  • decisionengine.framework.tests.test_client_server module
    • test_client_get_loglevel()
    • test_client_print_product()
    • test_client_set_loglevel()
    • test_client_status_msg_to_logger()
  • decisionengine.framework.tests.test_combined_channels module
    • test_combined_channels()
    • test_combined_channels_3g()
  • decisionengine.framework.tests.test_defaults module
    • test_defaults()
  • decisionengine.framework.tests.test_dynamic_test_modules module
    • test_dynamic_publisher()
    • test_dynamic_source()
    • test_dynamic_transform()
  • decisionengine.framework.tests.test_empty_config module
    • test_client_can_start_one_channel_added_after_startup()
  • decisionengine.framework.tests.test_error_on_acquire module
    • test_error_on_acquire()
  • decisionengine.framework.tests.test_module_program_options module
    • test_acquire_for_sources()
    • test_config_templates()
    • test_descriptions()
    • test_help()
    • test_module_alias()
  • decisionengine.framework.tests.test_publisher_status module
    • test_publisher_status()
  • decisionengine.framework.tests.test_publisher_status_board module
    • test_publisher_status_board()
  • decisionengine.framework.tests.test_query_tool_server module
    • test_query_tool()
  • decisionengine.framework.tests.test_reaper module
    • test_client_can_get_de_server_reaper_status()
  • decisionengine.framework.tests.test_same_source_types module
    • test_same_source_types_separate_channels()
  • decisionengine.framework.tests.test_sample_config module
    • stopped_channel_opts()
    • test_client_can_get_de_server_status()
    • test_client_can_kill_one_channel()
    • test_client_can_restart_all_channels()
    • test_client_can_restart_one_channel()
    • test_client_logger_level()
    • test_client_non_real_channel()
  • decisionengine.framework.tests.test_shared_sources module
    • record_that_matches()
    • test_conflicting_source_configurations()
    • test_shared_source()
  • decisionengine.framework.tests.test_start_with_bad_channels module
    • _consumes_not_subset()
    • _expected_circularity()
    • _missing_consumes()
    • _missing_produces()
    • test_client_can_get_products_no_channels()
  • decisionengine.framework.tests.test_status_during_startup module
    • test_status_during_startup()
  • Module contents
• decisionengine.framework.util package
  • Submodules
  • decisionengine.framework.util.countdown module
    • Countdown
  • decisionengine.framework.util.fs module
    • files_with_extensions()
  • decisionengine.framework.util.logparser module
    • console_scripts_main()
    • create_parser()
    • execute_command_from_args()
    • main()
    • matches_constraint()
    • parse_constraints()
  • decisionengine.framework.util.metrics module
    • Counter
      • Counter._abc_impl
    • Gauge
      • Gauge._DEFAULT_MULTIPROC_MODE
      • Gauge.__determine_multiprocess_mode_existence()
      • Gauge._abc_impl
    • Histogram
      • Histogram._abc_impl
    • Summary
      • Summary._abc_impl
    • display_metrics()
  • decisionengine.framework.util.reaper module
    • main()
  • decisionengine.framework.util.redis_stats module
    • redis_stats()
  • decisionengine.framework.util.singleton module
    • ScopedSingleton
      • ScopedSingleton._instances
    • ScopedSingletonABC
    • Singleton
      • Singleton._instances
    • SingletonABC
  • decisionengine.framework.util.sockets module
    • get_random_port()
  • decisionengine.framework.util.subclasses module
    • _derived_class()
    • all_subclasses()
  • Module contents

Submodules

decisionengine.framework.about module

PEP-0396 provides instructions for providing module versions While we are at it, add a few other useful bits

decisionengine.framework.version module

Module contents