:py:mod:`integration`
=====================

.. py:module:: conda.testing.integration

.. autoapi-nested-parse::

   These helpers were originally defined in tests/test_create.py,
   but were refactored here so downstream projects can benefit from
   them too.



Classes
-------

.. autoapisummary::

   conda.testing.integration.Commands



Functions
---------

.. autoapisummary::

   conda.testing.integration.escape_for_winpath
   conda.testing.integration.running_a_python_capable_of_unicode_subprocessing
   conda.testing.integration.set_tmpdir
   conda.testing.integration._get_temp_prefix
   conda.testing.integration.make_temp_prefix
   conda.testing.integration.FORCE_temp_prefix
   conda.testing.integration.run_command
   conda.testing.integration.make_temp_env
   conda.testing.integration.make_temp_package_cache
   conda.testing.integration.make_temp_channel
   conda.testing.integration.create_temp_location
   conda.testing.integration.tempdir
   conda.testing.integration.reload_config
   conda.testing.integration.package_is_installed
   conda.testing.integration.get_shortcut_dir



Attributes
----------

.. autoapisummary::

   conda.testing.integration.TEST_LOG_LEVEL
   conda.testing.integration.PYTHON_BINARY
   conda.testing.integration.BIN_DIRECTORY
   conda.testing.integration.UNICODE_CHARACTERS
   conda.testing.integration.UNICODE_CHARACTERS_RESTRICTED
   conda.testing.integration.which_or_where
   conda.testing.integration.cp_or_copy
   conda.testing.integration.env_or_set
   conda.testing.integration.SPACER_CHARACTER
   conda.testing.integration.tmpdir_in_use


.. py:data:: TEST_LOG_LEVEL

   

.. py:data:: PYTHON_BINARY

   

.. py:data:: BIN_DIRECTORY

   

.. py:data:: UNICODE_CHARACTERS
   :value: 'ōγђ家固한áêñßôç'

   

.. py:data:: UNICODE_CHARACTERS_RESTRICTED
   :value: 'abcdef'

   

.. py:data:: which_or_where

   

.. py:data:: cp_or_copy

   

.. py:data:: env_or_set

   

.. py:data:: SPACER_CHARACTER
   :value: ' '

   

.. py:function:: escape_for_winpath(p)


.. py:function:: running_a_python_capable_of_unicode_subprocessing()


.. py:data:: tmpdir_in_use

   

.. py:function:: set_tmpdir(tmpdir)


.. py:function:: _get_temp_prefix(name=None, use_restricted_unicode=False)


.. py:function:: make_temp_prefix(name=None, use_restricted_unicode=False, _temp_prefix=None)

   When the env. you are creating will be used to install Python 2.7 on Windows
   only a restricted amount of Unicode will work, and probably only those chars
   in your current codepage, so the characters in UNICODE_CHARACTERS_RESTRICTED
   should probably be randomly generated from that instead. The problem here is
   that the current codepage needs to be able to handle 'sys.prefix' otherwise
   ntpath will fall over.


.. py:function:: FORCE_temp_prefix(name=None, use_restricted_unicode=False)


.. py:class:: Commands


   .. py:attribute:: COMPARE
      :value: 'compare'

      

   .. py:attribute:: CONFIG
      :value: 'config'

      

   .. py:attribute:: CLEAN
      :value: 'clean'

      

   .. py:attribute:: CREATE
      :value: 'create'

      

   .. py:attribute:: INFO
      :value: 'info'

      

   .. py:attribute:: INSTALL
      :value: 'install'

      

   .. py:attribute:: LIST
      :value: 'list'

      

   .. py:attribute:: REMOVE
      :value: 'remove'

      

   .. py:attribute:: SEARCH
      :value: 'search'

      

   .. py:attribute:: UPDATE
      :value: 'update'

      

   .. py:attribute:: RUN
      :value: 'run'

      


.. py:function:: run_command(command, prefix, *arguments, **kwargs) -> tuple[str, str, int]


.. py:function:: make_temp_env(*packages, **kwargs) -> Iterator[str]


.. py:function:: make_temp_package_cache() -> Iterator[str]


.. py:function:: make_temp_channel(packages) -> Iterator[str]


.. py:function:: create_temp_location() -> str


.. py:function:: tempdir() -> Iterator[str]


.. py:function:: reload_config(prefix) -> None


.. py:function:: package_is_installed(prefix: str | os.PathLike | pathlib.Path, spec: str | conda.models.match_spec.MatchSpec) -> conda.models.records.PrefixRecord | None


.. py:function:: get_shortcut_dir(prefix_for_unix=sys.prefix)