:py:mod:`calliope`
==================

.. py:module:: calliope

.. autoapi-nested-parse::

   Calliope is a set of tools for processing playlists.

   This module contains the core parts of Calliope.



Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   bandcamp/index.rst
   beets/index.rst
   diff/index.rst
   export/index.rst
   import_/index.rst
   lastfm/index.rst
   listenbrainz/index.rst
   musicbrainz/index.rst
   play/index.rst
   select/index.rst
   shuffle/index.rst
   spotify/index.rst
   stat/index.rst
   subprojects/index.rst
   suggest/index.rst
   sync/index.rst
   tracker/index.rst
   validate/index.rst
   youtube/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   __main__/index.rst
   cache/index.rst
   cli/index.rst
   config/index.rst
   database/index.rst
   playlist/index.rst
   resolvers/index.rst
   sync_operation/index.rst
   utils/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   calliope.DisabledModule
   calliope.FailedModule
   calliope.ModuleLoader



Functions
~~~~~~~~~

.. autoapisummary::

   calliope.uri_to_path



.. py:class:: DisabledModule(name)

   Helper to raise ImportError exceptions for disabled modules.

   .. py:method:: __getattr__(attr)



.. py:class:: FailedModule(name, error)

   Helper to defer ImportError exceptions until module is actually used.

   .. py:method:: __getattr__(attr)


   .. py:method:: runtime_error(command_name=None)

      Return an error appropriate for display in CLI.


   .. py:method:: runtime_error_gobject_introspection(command_name=None)



.. py:class:: ModuleLoader

   Wrapper module import to avoid requiring all dependencies at import time.

   We want `import calliope` to import the whole Calliope library. However,
   this pulls in a lot of dependencies by default. This helper class allows
   features to be disabled at runtime (used in PyPI installs), or at configure
   time (used in Meson installs).

   .. py:method:: load_config()


   .. py:method:: maybe_load_module(name)



.. py:function:: uri_to_path(uri)

   Convert a file:/// URI to a pathlib.Path.