:py:mod:`calliope.musicbrainz.includes`
=======================================

.. py:module:: calliope.musicbrainz.includes

.. autoapi-nested-parse::

   Helpers for filtering data when querying MusicBrainz.



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

Classes
~~~~~~~

.. autoapisummary::

   calliope.musicbrainz.includes.MBType
   calliope.musicbrainz.includes.IncludeKey



Functions
~~~~~~~~~

.. autoapisummary::

   calliope.musicbrainz.includes.all_include_key_fullnames
   calliope.musicbrainz.includes.typenames
   calliope.musicbrainz.includes.get_key
   calliope.musicbrainz.includes.expand_fullname_patterns



Attributes
~~~~~~~~~~

.. autoapisummary::

   calliope.musicbrainz.includes.ALL_MB_TYPES
   calliope.musicbrainz.includes.INCLUDE_KEYS


.. py:class:: MBType(*args, **kwds)


   Bases: :py:obj:`enum.Enum`

   Supported MusicBrainz resource types.

   .. py:attribute:: ARTIST
      :value: 0

      

   .. py:attribute:: RECORDING
      :value: 1

      

   .. py:attribute:: RELEASE
      :value: 2

      

   .. py:attribute:: RELEASE_GROUP
      :value: 4

      

   .. py:attribute:: WORK
      :value: 4

      

   .. py:method:: typename()



.. py:data:: ALL_MB_TYPES

   

.. py:class:: IncludeKey


   Include flags used in MusicBrainz API queries.

   Each MusicBrainz API call has an 'include' parameter to control what data
   is returned. This class represents each possible 'include' option.


   .. py:attribute:: types
      :type: set(MBType)

      

   .. py:attribute:: name
      :type: str

      

   .. py:attribute:: response_keys
      :type: [str]

      

   .. py:method:: applies_to_typename(typename)


   .. py:method:: fullnames()

      List all fully qualified names of this key.

      A fullname is formatted as `typename.keyname`, for example:

        * artist.url-rels
        * recording.url-rels



   .. py:method:: outname()

      Name used in Calliope Item keys.

      For example, 'artist-rels' becomes 'artist_rels'.



   .. py:method:: __str__()

      Return str(self).


   .. py:method:: __hash__()

      Return hash(self).



.. py:data:: INCLUDE_KEYS

   

.. py:function:: all_include_key_fullnames()


.. py:function:: typenames()


.. py:function:: get_key(fullname)


.. py:function:: expand_fullname_patterns(patterns)

   Helper for tools which accept glob patterns for include-keys.

   This allows commandline users to specify "artist.*" rather than listing
   all artist include-keys explicitly.