aqt.import_export.exporting
===========================

.. py:module:: aqt.import_export.exporting


Classes
-------

.. autoapisummary::

   aqt.import_export.exporting.ExportDialog
   aqt.import_export.exporting.ExportOptions
   aqt.import_export.exporting.Exporter
   aqt.import_export.exporting.ColpkgExporter
   aqt.import_export.exporting.ApkgExporter
   aqt.import_export.exporting.NoteCsvExporter
   aqt.import_export.exporting.CardCsvExporter


Functions
---------

.. autoapisummary::

   aqt.import_export.exporting.export_progress_update


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

.. py:class:: ExportDialog(mw: aqt.main.AnkiQt, did: anki.decks.DeckId | None = None, nids: collections.abc.Sequence[anki.notes.NoteId] | None = None, parent: QWidget | None = None)

   Bases: :py:obj:`QDialog`


   .. py:attribute:: mw


   .. py:attribute:: col


   .. py:attribute:: frm


   .. py:attribute:: exporter
      :type:  Exporter


   .. py:attribute:: nids
      :value: None



   .. py:method:: setup(did: anki.decks.DeckId | None) -> None


   .. py:method:: exporter_changed(idx: int) -> None


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


   .. py:method:: get_out_path() -> str | None


   .. py:method:: options(out_path: str) -> ExportOptions


   .. py:method:: current_deck_id() -> anki.decks.DeckId | None


   .. py:method:: current_deck() -> anki.decks.DeckNameId | None


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


.. py:class:: ExportOptions

   .. py:attribute:: out_path
      :type:  str


   .. py:attribute:: include_scheduling
      :type:  bool


   .. py:attribute:: include_deck_configs
      :type:  bool


   .. py:attribute:: include_media
      :type:  bool


   .. py:attribute:: include_tags
      :type:  bool


   .. py:attribute:: include_html
      :type:  bool


   .. py:attribute:: include_deck
      :type:  bool


   .. py:attribute:: include_notetype
      :type:  bool


   .. py:attribute:: include_guid
      :type:  bool


   .. py:attribute:: legacy_support
      :type:  bool


   .. py:attribute:: limit
      :type:  anki.collection.ExportLimit


.. py:class:: Exporter

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: extension
      :type:  str


   .. py:attribute:: show_deck_list
      :value: False



   .. py:attribute:: show_include_scheduling
      :value: False



   .. py:attribute:: show_include_deck_configs
      :value: False



   .. py:attribute:: show_include_media
      :value: False



   .. py:attribute:: show_include_tags
      :value: False



   .. py:attribute:: show_include_html
      :value: False



   .. py:attribute:: show_legacy_support
      :value: False



   .. py:attribute:: show_include_deck
      :value: False



   .. py:attribute:: show_include_notetype
      :value: False



   .. py:attribute:: show_include_guid
      :value: False



   .. py:method:: export(mw: aqt.main.AnkiQt, options: ExportOptions) -> None
      :abstractmethod:



   .. py:method:: name() -> str
      :staticmethod:

      :abstractmethod:



.. py:class:: ColpkgExporter

   Bases: :py:obj:`Exporter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: extension
      :value: 'colpkg'



   .. py:attribute:: show_include_media
      :value: True



   .. py:attribute:: show_legacy_support
      :value: True



   .. py:method:: name() -> str
      :staticmethod:



   .. py:method:: export(mw: aqt.main.AnkiQt, options: ExportOptions) -> None


.. py:class:: ApkgExporter

   Bases: :py:obj:`Exporter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: extension
      :value: 'apkg'



   .. py:attribute:: show_deck_list
      :value: True



   .. py:attribute:: show_include_scheduling
      :value: True



   .. py:attribute:: show_include_deck_configs
      :value: True



   .. py:attribute:: show_include_media
      :value: True



   .. py:attribute:: show_legacy_support
      :value: True



   .. py:method:: name() -> str
      :staticmethod:



   .. py:method:: export(mw: aqt.main.AnkiQt, options: ExportOptions) -> None


.. py:class:: NoteCsvExporter

   Bases: :py:obj:`Exporter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: extension
      :value: 'txt'



   .. py:attribute:: show_deck_list
      :value: True



   .. py:attribute:: show_include_html
      :value: True



   .. py:attribute:: show_include_tags
      :value: True



   .. py:attribute:: show_include_deck
      :value: True



   .. py:attribute:: show_include_notetype
      :value: True



   .. py:attribute:: show_include_guid
      :value: True



   .. py:method:: name() -> str
      :staticmethod:



   .. py:method:: export(mw: aqt.main.AnkiQt, options: ExportOptions) -> None


.. py:class:: CardCsvExporter

   Bases: :py:obj:`Exporter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: extension
      :value: 'txt'



   .. py:attribute:: show_deck_list
      :value: True



   .. py:attribute:: show_include_html
      :value: True



   .. py:method:: name() -> str
      :staticmethod:



   .. py:method:: export(mw: aqt.main.AnkiQt, options: ExportOptions) -> None


.. py:function:: export_progress_update(progress: anki.collection.Progress, update: aqt.progress.ProgressUpdate) -> None