:py:mod:`yaml_file`
===================

.. py:module:: conda.env.specs.yaml_file

.. autoapi-nested-parse::

   Define YAML spec.



Classes
-------

.. autoapisummary::

   conda.env.specs.yaml_file.YamlFileSpec




.. py:class:: YamlFileSpec(filename=None, **kwargs)


   Bases: :py:obj:`conda.plugins.types.EnvironmentSpecBase`

   **EXPERIMENTAL**

   Base class for all environment specifications.

   Environment specs parse different types of environment definition files
   (environment.yml, requirements.txt, pyproject.toml, etc.) into a common
   Environment object model.

   .. py:property:: environment
      :type: conda.env.env.EnvironmentYaml


   .. py:property:: env
      :type: conda.models.environment.Environment

      Express the provided environment file as a conda environment object.

      :returns Environment: the conda environment represented by the file.

   .. py:attribute:: detection_supported
      :value: False

      

   .. py:attribute:: _environment

      

   .. py:attribute:: extensions

      

   .. py:method:: can_handle()

      Validates loader can process environment definition.
      This can handle if:
          * the provided file exists
          * the provided file ends in the supported file extensions (.yaml or .yml)
          * the yaml file can be loaded and is not empty

      :return: True or False