sec_parser.processing_steps.top_section_manager
===============================================

.. py:module:: sec_parser.processing_steps.top_section_manager


Attributes
----------

.. autoapisummary::

   sec_parser.processing_steps.top_section_manager.part_pattern
   sec_parser.processing_steps.top_section_manager.item_pattern


Classes
-------

.. autoapisummary::

   sec_parser.processing_steps.top_section_manager._Candidate
   sec_parser.processing_steps.top_section_manager.TopSectionManager
   sec_parser.processing_steps.top_section_manager.TopSectionManagerFor10Q
   sec_parser.processing_steps.top_section_manager.TopSectionManagerFor10K


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

.. py:data:: part_pattern

.. py:data:: item_pattern

.. py:class:: _Candidate

   .. py:attribute:: section_type
      :type:  sec_parser.semantic_elements.top_section_title_types.TopSectionInFiling


   .. py:attribute:: element
      :type:  sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement


.. py:class:: TopSectionManager(filing_sections: sec_parser.semantic_elements.top_section_title_types.FilingSections, *, types_to_process: set[type[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement]] | None = None, types_to_exclude: set[type[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement]] | None = None)

   Bases: :py:obj:`sec_parser.processing_steps.abstract_classes.abstract_elementwise_processing_step.AbstractElementwiseProcessingStep`


   Documents are divided into sections, subsections, and so on.
   Top level sections are the highest level of sections and are
   standardized across each type of document.


   An example of a Top Level Section in a 10-Q report is
   "Part I, Item 3. Quantitative and Qualitative
   Disclosures About Market Risk.".


   .. py:attribute:: _NUM_ITERATIONS
      :value: 2



   .. py:attribute:: _filing_sections


   .. py:attribute:: _candidates
      :type:  list[_Candidate]
      :value: []



   .. py:attribute:: _selected_candidates
      :type:  tuple[_Candidate, Ellipsis] | None
      :value: None



   .. py:attribute:: _last_part
      :type:  str
      :value: '?'



   .. py:attribute:: _last_order_number


   .. py:method:: is_match_part_or_item(text: str) -> bool
      :classmethod:



   .. py:method:: match_part(text: str) -> str | None
      :staticmethod:



   .. py:method:: match_item(text: str) -> str | None
      :staticmethod:



   .. py:method:: _process_element(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement, context: sec_parser.processing_steps.abstract_classes.abstract_elementwise_processing_step.ElementProcessingContext) -> sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement


   .. py:method:: _process_iteration_0(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement) -> None


   .. py:method:: _process_iteration_1(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement) -> sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement


   .. py:method:: _identify_candidate(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement) -> None


   .. py:method:: _get_section_type(identifier: str) -> sec_parser.semantic_elements.top_section_title_types.TopSectionInFiling


   .. py:method:: _select_candidates() -> tuple[_Candidate, Ellipsis]


   .. py:method:: _process_selected_candidates(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement) -> sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement


   .. py:method:: _update_last_order_number(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement, order: float) -> None


   .. py:method:: _log_order_number_not_greater(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement, order: float) -> None


   .. py:method:: _create_top_section_title(candidate: _Candidate) -> sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement


.. py:class:: TopSectionManagerFor10Q(*, types_to_process: set[type[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement]] | None = None, types_to_exclude: set[type[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement]] | None = None)

   Bases: :py:obj:`TopSectionManager`


   Specialized version of TopSectionManagerForFiling for handling 10-Q filings.
   Automatically uses FilingSectionsIn10Q while maintaining all the functionality
   of the base class.


.. py:class:: TopSectionManagerFor10K(*, types_to_process: set[type[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement]] | None = None, types_to_exclude: set[type[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement]] | None = None)

   Bases: :py:obj:`TopSectionManager`


   Specialized version of TopSectionManagerForFiling for handling 10-K filings.
   Automatically uses FilingSectionsIn10K while maintaining all the functionality
   of the base class.