flow.utils package

Subpackages

• flow.utils.aimsun package
  • flow.utils.aimsun.api module
  • flow.utils.aimsun.constants module
  • flow.utils.aimsun.generate module
  • flow.utils.aimsun.run module
  • flow.utils.aimsun.struct module

Submodules

flow.utils.exceptions module

Flow-specific exceptions.

exception flow.utils.exceptions.FatalFlowError(msg)

Bases: Exception

Exception class for Flow errors which do not allow for continuation.

flow.utils.flow_warnings module

Warnings that may be printed by Flow (e.g. deprecation warnings).

flow.utils.flow_warnings.deprecated(base, new_path)

Print a deprecation warning.

This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emitted when the function is used.

flow.utils.flow_warnings.deprecated_attribute(obj, dep_from, dep_to)

Print a deprecation warning.

Parameters

obj : class

The class with the deprecated attribute

dep_from : str

old (deprecated) name of the attribute

dep_to : str

new name for the attribute

flow.utils.registry module

flow.utils.rllib module

Module contents

empty init file to ensure documentation for utils is created.

exception flow.utils.FatalFlowError(msg)

Bases: Exception

Exception class for Flow errors which do not allow for continuation.