:py:mod:`anypytools.abcutils`
=============================

.. py:module:: anypytools.abcutils

.. autodoc2-docstring:: anypytools.abcutils
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`AnyPyProcess <anypytools.abcutils.AnyPyProcess>`
     - .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess
          :summary:
   * - :py:obj:`Task <anypytools.abcutils.Task>`
     - .. autodoc2-docstring:: anypytools.abcutils.Task
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`execute_anybodycon <anypytools.abcutils.execute_anybodycon>`
     - .. autodoc2-docstring:: anypytools.abcutils.execute_anybodycon
          :summary:

API
~~~

.. py:function:: execute_anybodycon(macro, logfile=None, anybodycon_path=None, timeout=3600, keep_macrofile=False, env=None, priority=BELOW_NORMAL_PRIORITY_CLASS, debug_mode=0, folder=None, interactive_mode=False)
   :canonical: anypytools.abcutils.execute_anybodycon

   .. autodoc2-docstring:: anypytools.abcutils.execute_anybodycon

.. py:class:: AnyPyProcess(num_processes=get_ncpu(), anybodycon_path=None, timeout=3600, silent=False, ignore_errors=None, warnings_to_include=None, fatal_warnings=False, return_task_info=None, keep_logfiles=False, logfile_prefix=None, python_env=None, debug_mode=0, use_gui=False, priority=BELOW_NORMAL_PRIORITY_CLASS, interactive_mode=False, **kwargs)
   :canonical: anypytools.abcutils.AnyPyProcess

   Bases: :py:obj:`object`

   .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess.__init__

   .. py:method:: save_results(filename, append=False)
      :canonical: anypytools.abcutils.AnyPyProcess.save_results

      .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess.save_results

   .. py:method:: save_to_hdf5(filename, batch_name=None)
      :canonical: anypytools.abcutils.AnyPyProcess.save_to_hdf5

      .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess.save_to_hdf5

   .. py:method:: load_results(filename)
      :canonical: anypytools.abcutils.AnyPyProcess.load_results

      .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess.load_results

   .. py:method:: start_macro(macrolist=None, folderlist=None, search_subdirs=None, logfile=None) -> anypytools.tools.AnyPyProcessOutputList
      :canonical: anypytools.abcutils.AnyPyProcess.start_macro

      .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess.start_macro

   .. py:method:: _worker(task, task_queue)
      :canonical: anypytools.abcutils.AnyPyProcess._worker

      .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess._worker

   .. py:method:: _schedule_processes(tasklist: typing.List[anypytools.abcutils.Task]) -> typing.Generator[anypytools.abcutils.Task, None, None]
      :canonical: anypytools.abcutils.AnyPyProcess._schedule_processes

      .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess._schedule_processes

   .. py:method:: cleanup_logfiles(tasklist)
      :canonical: anypytools.abcutils.AnyPyProcess.cleanup_logfiles

      .. autodoc2-docstring:: anypytools.abcutils.AnyPyProcess.cleanup_logfiles

.. py:class:: Task(folder=None, macro=None, taskname=None, number=1, logfile=None)
   :canonical: anypytools.abcutils.Task

   Bases: :py:obj:`object`

   .. autodoc2-docstring:: anypytools.abcutils.Task

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.abcutils.Task.__init__

   .. py:method:: has_error()
      :canonical: anypytools.abcutils.Task.has_error

      .. autodoc2-docstring:: anypytools.abcutils.Task.has_error

   .. py:method:: add_error(error_msg)
      :canonical: anypytools.abcutils.Task.add_error

      .. autodoc2-docstring:: anypytools.abcutils.Task.add_error

   .. py:method:: get_output(include_task_info=True)
      :canonical: anypytools.abcutils.Task.get_output

      .. autodoc2-docstring:: anypytools.abcutils.Task.get_output

   .. py:method:: from_output_data(task_output)
      :canonical: anypytools.abcutils.Task.from_output_data
      :classmethod:

      .. autodoc2-docstring:: anypytools.abcutils.Task.from_output_data

   .. py:method:: from_output_list(outputlist)
      :canonical: anypytools.abcutils.Task.from_output_list
      :classmethod:

      .. autodoc2-docstring:: anypytools.abcutils.Task.from_output_list

   .. py:method:: from_macrofolderlist(macrolist, folderlist, explicit_logfile=None)
      :canonical: anypytools.abcutils.Task.from_macrofolderlist
      :classmethod:

      .. autodoc2-docstring:: anypytools.abcutils.Task.from_macrofolderlist

   .. py:method:: is_valid(output_elem)
      :canonical: anypytools.abcutils.Task.is_valid
      :staticmethod:

      .. autodoc2-docstring:: anypytools.abcutils.Task.is_valid