fireworks.utilities package¶
Subpackages¶
Submodules¶
fireworks.utilities.dict_mods module¶
-
fireworks.utilities.dict_mods.
apply_mod
(modification, obj)¶ Note that modify makes actual in-place modifications. It does not return a copy.
Parameters: - modification – Modification must be {action_keyword : settings}, where action_keyword is a supported DictMod
- obj – A dict to be modified
-
fireworks.utilities.dict_mods.
get_nested_dict
(input_dict, key)¶
fireworks.utilities.fw_serializers module¶
-
fireworks.utilities.fw_serializers.
DATETIME_HANDLER
(obj)¶
-
class
fireworks.utilities.fw_serializers.
FWSerializable
¶ Bases:
object
To create a serializable object within FireWorks, you should subclass this class and implement the to_dict() and from_dict() methods.
If you want the load_object() implicit de-serialization to work, you must also:
- Use the @serialize_fw decorator on to_dict()
- Override the _fw_name parameter with a unique key.
See documentation of load_object() for more details.
The use of @classmethod for from_dict allows you to define a superclass that implements the to_dict() and from_dict() for all its subclasses.
For an example of serialization, see the class QueueAdapterBase.
-
as_dict
()¶
-
classmethod
from_dict
(m_dict)¶
-
classmethod
from_file
(filename, f_format=None)¶ Load a serialization of this object from a file.
Parameters: Returns: FWSerializable
-
classmethod
from_format
(f_str, f_format=u'json')¶ convert from a String representation to its Object.
Parameters: Returns: FWSerializable
-
fw_name
¶
-
to_db_dict
()¶
-
to_dict
()¶
-
to_file
(filename, f_format=None, **kwargs)¶ Write a serialization of this object to a file.
Parameters:
-
fireworks.utilities.fw_serializers.
get_default_serialization
(cls)¶
-
fireworks.utilities.fw_serializers.
load_object
(obj_dict)¶ Creates an instantiation of a class based on a dictionary representation. We implicitly determine the Class through introspection along with information in the dictionary.
We search for a class with the _fw_name property equal to obj_dict[‘_fw_name’] If the @module key is set, that module is checked first for a matching class to improve speed of lookup. Afterwards, the modules in the USER_PACKAGES global parameter are checked.
Refactoring class names, module names, etc. will not break object loading as long as:
- the _fw_name property is maintained the same AND
- the refactored module is kept within USER_PACKAGES
You can get around these limitations if you really want: i) If you want to change the fw_name of an object you can set the FW_NAME_UPDATES key ii) If you want to put a refactored module in a new place add an entry to USER_PACKAGES
Parameters: obj_dict (dict) – the dict representation of the class
-
fireworks.utilities.fw_serializers.
load_object_from_file
(filename, f_format=None)¶ Implicitly load an object from a file. just a friendly wrapper to load_object()
Parameters:
-
fireworks.utilities.fw_serializers.
reconstitute_dates
(obj_dict)¶
-
fireworks.utilities.fw_serializers.
recursive_deserialize
(func)¶ a decorator to add FW serializations keys see documentation of FWSerializable for more details
-
fireworks.utilities.fw_serializers.
recursive_dict
(obj, preserve_unicode=True)¶
-
fireworks.utilities.fw_serializers.
recursive_serialize
(func)¶ a decorator to add FW serializations keys see documentation of FWSerializable for more details
-
fireworks.utilities.fw_serializers.
serialize_fw
(func)¶ a decorator to add FW serializations keys see documentation of FWSerializable for more details
fireworks.utilities.fw_utilities module¶
-
class
fireworks.utilities.fw_utilities.
DataServer
(address=None, authkey=None, serializer='pickle')¶ Bases:
multiprocessing.managers.BaseManager
Provide a server that can host shared objects between multiprocessing Processes (that normally can’t share data). For example, a common LaunchPad is shared between processes and pinging launches is coordinated to limit DB hits.
-
class
fireworks.utilities.fw_utilities.
NestedClassGetter
¶ Bases:
object
Used to help pickle inner classes, e.g. see Workflow.Links When called with the containing class as the first argument, and the name of the nested class as the second argument, returns an instance of the nested class.
-
fireworks.utilities.fw_utilities.
create_datestamp_dir
(root_dir, l_logger, prefix='block_')¶ Internal method to create a new block or launcher directory. The dir name is based on the time and the FW_BLOCK_FORMAT
Parameters: - root_dir – directory to create the new dir in
- l_logger – the logger to use
- prefix – the prefix for the new dir, default=”block_“
-
fireworks.utilities.fw_utilities.
explicit_serialize
(o)¶
-
fireworks.utilities.fw_utilities.
get_fw_logger
(name, l_dir=None, file_levels=('DEBUG', 'ERROR'), stream_level='DEBUG', formatter=<logging.Formatter object>, clear_logs=False)¶ Convenience method to return a logger.
Parameters: - name – name of the logger that sets the groups, e.g. ‘group1.set2’
- l_dir – the directory to put the log file
- file_levels – iterable describing level(s) to log to file(s). default: (‘DEBUG’, ‘ERROR’)
- stream_level – level to log to standard output. default: ‘DEBUG’
- formatter – logging format. default: FW_LOGGING_FORMATTER
- clear_logs – whether to clear the logger with the same name
-
fireworks.utilities.fw_utilities.
get_my_host
()¶
-
fireworks.utilities.fw_utilities.
get_my_ip
()¶
-
fireworks.utilities.fw_utilities.
get_slug
(m_str)¶
-
fireworks.utilities.fw_utilities.
log_exception
(m_logger, msgs)¶ A shortcut wrapper around log_fancy for exceptions
Parameters: - m_logger (logger) – The logger object
- msgs ([str]) – String or iterable of Strings, will be joined by newlines
-
fireworks.utilities.fw_utilities.
log_fancy
(m_logger, msgs, log_lvl='info', add_traceback=False)¶ A wrapper around the logger messages useful for multi-line logs. Helps to group log messages by adding a fancy border around it, which enhances readability of log lines meant to be read as a unit.
Parameters:
-
fireworks.utilities.fw_utilities.
log_multi
(m_logger, msg, log_lvl='info')¶ Parameters:
-
fireworks.utilities.fw_utilities.
plot_wf
(wf, depth_factor=1.0, breadth_factor=2.0, labels_on=True, numerical_label=False, text_loc_factor=1.0, save_as=None, style='rD--', markersize=10, markerfacecolor='blue', fontsize=12)¶ Generate a visual representation of the workflow. Useful for checking whether the firework connections are in order before launching the workflow.
Parameters: - wf (Workflow) – workflow object.
- depth_factor (float) – adjust this to stretch the plot in y direction.
- breadth_factor (float) – adjust this to stretch the plot in x direction.
- labels_on (bool) – whether to label the nodes or not. The default is to lable the nodes using the firework names.
- numerical_label (bool) – set this to label the nodes using the firework ids.
- text_loc_factor (float) – adjust the label location.
- save_as (str) – save the figure to the given name.
- style (str) – marker style.
- markersize (int) – marker size.
- markerfacecolor (str) – marker face color.
- fontsize (int) – font size for the node label.
fireworks.utilities.timing module¶
-
class
fireworks.utilities.timing.
NullTimer
¶ Bases:
fireworks.utilities.timing.Timer
Support performance timer interface, but do absolutely nothing. This is useful to avoid many tiresome if/else blocks.
-
block
(stage)¶
-
start
(stage)¶
-
stop
(stage)¶
-
write
(**kwargs)¶
-
-
class
fireworks.utilities.timing.
Timer
(name)¶ Bases:
object
Simple performance timer.
- Usage:
p = Timer(“myname”) for thing in all_things:
p.start(“stage1”) do_stage_1() p.stop(“stage1”) # alt. ‘with’ interface with p.block(“stage2”):
do_something_else()
Limitations: - Instances are not thread-safe. - The set_ns() class method is not thread-safe. - The ‘with’ block() cannot be nested,
instead use different stages with begin()/end() pairs.- The only output format is CSV.
- There is no (easy) programmatic way to get the results.
-
block
(stage)¶
-
classmethod
set_ns
(val)¶ Set a namespace (prefix) for all timers. In output, the namespace will be separated by the timer name by a ”.”
-
start
(stage=u'null')¶ Begin timing.
-
stop
(stage=u'null')¶ Stop timing.
-
stop_all
()¶ Stop all timers. Idempotent.
-
write
(stream=<open file '<stdout>', mode 'w'>)¶ Write results (CSV) to a stream.
-
fireworks.utilities.timing.
any_fw_timers
()¶ Whether any timers are enabled and non-empty
Returns: True if so, False if not Return type: bool
-
fireworks.utilities.timing.
enable_fw_timer
(name, is_enabled)¶ Enable or disable a timer.
Parameters:
-
fireworks.utilities.timing.
get_fw_timer
(name)¶ G et timer, possibly a NullTimer, for a section of code.
If the user did not enable timers for this section, will return a NullTimer. Otherwise will return a Timer.
- Usage:
- timer = get_fw_timer(“StarWars”) timer.start(“jumpToLightSpeed”) jumpToLightSpeed() timer.stop(“jumpToLightSpeed”) ... print_fw_timers() # prints results of all timers
Parameters: name (str) – Name of a given timer. Returns: A timer instance Return type: Timer
-
fireworks.utilities.timing.
print_fw_timers
(stream=<open file '<stdout>', mode 'w'>)¶ Print results of all timers to the provided stream.
Parameters: stream – Output stream, only needs to support ‘write’ Returns: number of items (data rows) printed Return type: int
-
fireworks.utilities.timing.
timer_env_var
= u'FW_TIMERS'¶ Environment variable in which to list the enabled timers Use comma-separated strings, e.g.: