anki.notes
==========

.. py:module:: anki.notes


Attributes
----------

.. autoapisummary::

   anki.notes.DuplicateOrEmptyResult
   anki.notes.NoteFieldsCheckResult
   anki.notes.DefaultsForAdding
   anki.notes.NoteId


Classes
-------

.. autoapisummary::

   anki.notes.Note


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

.. py:data:: DuplicateOrEmptyResult

.. py:data:: NoteFieldsCheckResult

.. py:data:: DefaultsForAdding

.. py:data:: NoteId

.. py:class:: Note(col: anki.collection.Collection, model: anki.models.NotetypeDict | anki.models.NotetypeId | None = None, id: NoteId | None = None)

   Bases: :py:obj:`anki._legacy.DeprecatedNamesMixin`


   .. py:attribute:: flags
      :value: 0



   .. py:attribute:: data
      :value: ''



   .. py:attribute:: id
      :type:  NoteId


   .. py:attribute:: mid
      :type:  anki.models.NotetypeId


   .. py:attribute:: col


   .. py:method:: load() -> None


   .. py:method:: flush() -> None

      For an undo entry, use col.update_note() instead.



   .. py:method:: joined_fields() -> str


   .. py:method:: ephemeral_card(ord: int = 0, *, custom_note_type: anki.models.NotetypeDict | None = None, custom_template: anki.models.TemplateDict | None = None, fill_empty: bool = False) -> anki.cards.Card


   .. py:method:: cards() -> list[anki.cards.Card]


   .. py:method:: card_ids() -> collections.abc.Sequence[anki.cards.CardId]


   .. py:method:: note_type() -> anki.models.NotetypeDict | None


   .. py:method:: cloze_numbers_in_fields() -> collections.abc.Sequence[int]


   .. py:method:: keys() -> list[str]


   .. py:method:: values() -> list[str]


   .. py:method:: items() -> list[tuple[str, str]]


   .. py:method:: has_tag(tag: str) -> bool


   .. py:method:: remove_tag(tag: str) -> None


   .. py:method:: add_tag(tag: str) -> None

      Add tag. Duplicates will be stripped on save.



   .. py:method:: string_tags() -> str


   .. py:method:: set_tags_from_str(tags: str) -> None


   .. py:method:: fields_check() -> NoteFieldsCheckResult