pudl.extract.xbrl
=================

.. py:module:: pudl.extract.xbrl

.. autoapi-nested-parse::

   Generic extractor for all FERC XBRL data.



Attributes
----------

.. autoapisummary::

   pudl.extract.xbrl.logger


Classes
-------

.. autoapisummary::

   pudl.extract.xbrl._FilteringStream
   pudl.extract.xbrl.FercXbrlDatastore


Functions
---------

.. autoapisummary::

   pudl.extract.xbrl._suppress_arelle_message_spam
   pudl.extract.xbrl.convert_form


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

.. py:data:: logger

.. py:class:: _FilteringStream(wrapped, drop_patterns: list[re.Pattern[str]])

   Pass-through text stream that drops matching noisy lines.


   .. py:attribute:: _wrapped


   .. py:attribute:: _drop_patterns


   .. py:attribute:: _dropped_previous_line
      :value: False



   .. py:method:: write(text: str) -> int


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


.. py:function:: _suppress_arelle_message_spam()

   Filter known Arelle console spam without suppressing normal logs.


.. py:class:: FercXbrlDatastore(datastore: pudl.workspace.datastore.Datastore)

   Simple datastore wrapper for accessing ferc1 xbrl resources.


   .. py:attribute:: datastore


   .. py:method:: get_taxonomy(form: pudl.settings.FercForm) -> io.BytesIO

      Returns the path to the taxonomy entry point within the an archive.



   .. py:method:: get_filings(year: int, form: pudl.settings.FercForm) -> io.BytesIO

      Return the corresponding archive full of XBRL filings.



.. py:function:: convert_form(ferc_to_sqlite: pudl.settings.FercToSqliteDataConfig, form: pudl.settings.FercForm, datastore: FercXbrlDatastore, pudl_paths: pudl.workspace.setup.PudlPaths, batch_size: int | None = None, workers: int | None = None, loglevel: str = 'INFO') -> None

   Clone a single FERC XBRL form to SQLite.

   :param ferc_to_sqlite: Validated data configuration for converting FERC data to SQLite.
   :param form: FERC form number.
   :param datastore: Instance of a FERC XBRL datastore for retrieving data.
   :param pudl_paths: ``PudlPaths`` resource.
   :param batch_size: Number of XBRL filings to process in a single CPU process.
   :param workers: Number of CPU processes to create for processing XBRL filings.
   :param loglevel: Log level to pass to ``ferc_xbrl_extractor``.