:py:mod:`anypytools.tools`
==========================

.. py:module:: anypytools.tools

.. autodoc2-docstring:: anypytools.tools
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`AnyPyProcessOutput <anypytools.tools.AnyPyProcessOutput>`
     - .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutput
          :summary:
   * - :py:obj:`AnyPyProcessOutputList <anypytools.tools.AnyPyProcessOutputList>`
     - .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList
          :summary:
   * - :py:obj:`AMSVersion <anypytools.tools.AMSVersion>`
     - .. autodoc2-docstring:: anypytools.tools.AMSVersion
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`array2anyscript <anypytools.tools.array2anyscript>`
     - .. autodoc2-docstring:: anypytools.tools.array2anyscript
          :summary:
   * - :py:obj:`case_preserving_replace <anypytools.tools.case_preserving_replace>`
     - .. autodoc2-docstring:: anypytools.tools.case_preserving_replace
          :summary:
   * - :py:obj:`define2str <anypytools.tools.define2str>`
     - .. autodoc2-docstring:: anypytools.tools.define2str
          :summary:
   * - :py:obj:`get_ammr_version <anypytools.tools.get_ammr_version>`
     - .. autodoc2-docstring:: anypytools.tools.get_ammr_version
          :summary:
   * - :py:obj:`get_anybodycon_path <anypytools.tools.get_anybodycon_path>`
     - .. autodoc2-docstring:: anypytools.tools.get_anybodycon_path
          :summary:
   * - :py:obj:`winepath <anypytools.tools.winepath>`
     - .. autodoc2-docstring:: anypytools.tools.winepath
          :summary:
   * - :py:obj:`anybodycon_version <anypytools.tools.anybodycon_version>`
     - .. autodoc2-docstring:: anypytools.tools.anybodycon_version
          :summary:
   * - :py:obj:`parse_anybodycon_output <anypytools.tools.parse_anybodycon_output>`
     - .. autodoc2-docstring:: anypytools.tools.parse_anybodycon_output
          :summary:
   * - :py:obj:`wraptext <anypytools.tools.wraptext>`
     - .. autodoc2-docstring:: anypytools.tools.wraptext
          :summary:

API
~~~

.. py:class:: AnyPyProcessOutput(*args, **kwargs)
   :canonical: anypytools.tools.AnyPyProcessOutput

   Bases: :py:obj:`collections.OrderedDict`

   .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutput

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutput.__init__

   .. py:method:: __getitem__(key)
      :canonical: anypytools.tools.AnyPyProcessOutput.__getitem__

   .. py:method:: _repr_gen(prefix)
      :canonical: anypytools.tools.AnyPyProcessOutput._repr_gen

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutput._repr_gen

   .. py:method:: __repr__(_repr_running={}, prefix='')
      :canonical: anypytools.tools.AnyPyProcessOutput.__repr__

   .. py:method:: _get_index_length(index_var='auto')
      :canonical: anypytools.tools.AnyPyProcessOutput._get_index_length

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutput._get_index_length

   .. py:method:: to_dataframe(index_var: str | None = 'auto', interp_var=None, interp_val=None, interp_method='cubic')
      :canonical: anypytools.tools.AnyPyProcessOutput.to_dataframe

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutput.to_dataframe

.. py:class:: AnyPyProcessOutputList(*args)
   :canonical: anypytools.tools.AnyPyProcessOutputList

   Bases: :py:obj:`collections.abc.MutableSequence`

   .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList

   .. rubric:: Initialization

   .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.__init__

   .. py:method:: check(v)
      :canonical: anypytools.tools.AnyPyProcessOutputList.check

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.check

   .. py:method:: __len__()
      :canonical: anypytools.tools.AnyPyProcessOutputList.__len__

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.__len__

   .. py:method:: __getitem__(item)
      :canonical: anypytools.tools.AnyPyProcessOutputList.__getitem__

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.__getitem__

   .. py:method:: __delitem__(item)
      :canonical: anypytools.tools.AnyPyProcessOutputList.__delitem__

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.__delitem__

   .. py:method:: __setitem__(item, v)
      :canonical: anypytools.tools.AnyPyProcessOutputList.__setitem__

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.__setitem__

   .. py:method:: insert(item, v)
      :canonical: anypytools.tools.AnyPyProcessOutputList.insert

   .. py:method:: __str__()
      :canonical: anypytools.tools.AnyPyProcessOutputList.__str__

   .. py:method:: __repr__()
      :canonical: anypytools.tools.AnyPyProcessOutputList.__repr__

   .. py:method:: filter(function)
      :canonical: anypytools.tools.AnyPyProcessOutputList.filter

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.filter

   .. py:method:: shelve(filename, key='results')
      :canonical: anypytools.tools.AnyPyProcessOutputList.shelve

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.shelve

   .. py:method:: from_shelve(filename, key='results')
      :canonical: anypytools.tools.AnyPyProcessOutputList.from_shelve
      :classmethod:

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.from_shelve

   .. py:method:: tolist()
      :canonical: anypytools.tools.AnyPyProcessOutputList.tolist

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.tolist

   .. py:method:: to_dataframe(index_var='auto', include_task_info=False, **kwargs)
      :canonical: anypytools.tools.AnyPyProcessOutputList.to_dataframe

      .. autodoc2-docstring:: anypytools.tools.AnyPyProcessOutputList.to_dataframe

.. py:function:: array2anyscript(arr)
   :canonical: anypytools.tools.array2anyscript

   .. autodoc2-docstring:: anypytools.tools.array2anyscript

.. py:function:: case_preserving_replace(string, old, new)
   :canonical: anypytools.tools.case_preserving_replace

   .. autodoc2-docstring:: anypytools.tools.case_preserving_replace

.. py:function:: define2str(key, value=None)
   :canonical: anypytools.tools.define2str

   .. autodoc2-docstring:: anypytools.tools.define2str

.. py:function:: get_ammr_version(folder=None)
   :canonical: anypytools.tools.get_ammr_version

   .. autodoc2-docstring:: anypytools.tools.get_ammr_version

.. py:function:: get_anybodycon_path() -> str | None
   :canonical: anypytools.tools.get_anybodycon_path

   .. autodoc2-docstring:: anypytools.tools.get_anybodycon_path

.. py:function:: winepath(path, opts=None)
   :canonical: anypytools.tools.winepath

   .. autodoc2-docstring:: anypytools.tools.winepath

.. py:function:: anybodycon_version(anybodyconpath=None)
   :canonical: anypytools.tools.anybodycon_version

   .. autodoc2-docstring:: anypytools.tools.anybodycon_version

.. py:class:: AMSVersion
   :canonical: anypytools.tools.AMSVersion

   .. autodoc2-docstring:: anypytools.tools.AMSVersion

   .. py:attribute:: major
      :canonical: anypytools.tools.AMSVersion.major
      :type: int
      :value: None

      .. autodoc2-docstring:: anypytools.tools.AMSVersion.major

   .. py:attribute:: minor
      :canonical: anypytools.tools.AMSVersion.minor
      :type: int
      :value: None

      .. autodoc2-docstring:: anypytools.tools.AMSVersion.minor

   .. py:attribute:: patch
      :canonical: anypytools.tools.AMSVersion.patch
      :type: int
      :value: None

      .. autodoc2-docstring:: anypytools.tools.AMSVersion.patch

   .. py:attribute:: build
      :canonical: anypytools.tools.AMSVersion.build
      :type: int
      :value: None

      .. autodoc2-docstring:: anypytools.tools.AMSVersion.build

   .. py:method:: from_string(version_string)
      :canonical: anypytools.tools.AMSVersion.from_string
      :classmethod:

      .. autodoc2-docstring:: anypytools.tools.AMSVersion.from_string

   .. py:method:: _as_tuple()
      :canonical: anypytools.tools.AMSVersion._as_tuple

      .. autodoc2-docstring:: anypytools.tools.AMSVersion._as_tuple

   .. py:method:: __eq__(other)
      :canonical: anypytools.tools.AMSVersion.__eq__

   .. py:method:: __lt__(other)
      :canonical: anypytools.tools.AMSVersion.__lt__

   .. py:method:: __ne__(other)
      :canonical: anypytools.tools.AMSVersion.__ne__

   .. py:method:: __le__(other)
      :canonical: anypytools.tools.AMSVersion.__le__

   .. py:method:: __ge__(other)
      :canonical: anypytools.tools.AMSVersion.__ge__

   .. py:method:: __gt__(other)
      :canonical: anypytools.tools.AMSVersion.__gt__

.. py:function:: parse_anybodycon_output(raw, errors_to_ignore=None, warnings_to_include=None, fatal_warnings=False)
   :canonical: anypytools.tools.parse_anybodycon_output

   .. autodoc2-docstring:: anypytools.tools.parse_anybodycon_output

.. py:function:: wraptext(elem, initial_indent='', subsequent_indent=None)
   :canonical: anypytools.tools.wraptext

   .. autodoc2-docstring:: anypytools.tools.wraptext