sec_parser.processing_steps.top_section_manager_for_10q

Attributes

`IDENTIFIER_TO_10Q_SECTION`
`InvalidTopSectionIn10Q`
`TopSectionType`
`part_pattern`
`item_pattern`

Classes

`AbstractElementwiseProcessingStep`	AbstractElementwiseTransformStep class is used to iterate over
`ElementProcessingContext`	The ElementProcessingContext class is designed to provide context information
`TopSectionTitle`	The TopSectionTitle class represents the title and the beginning of a top-level
`_Candidate`
`TopSectionManagerFor10Q`	Documents are divided into sections, subsections, and so on.

Module Contents

class sec_parser.processing_steps.top_section_manager_for_10q.AbstractElementwiseProcessingStep(*, 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: sec_parser.processing_steps.abstract_classes.abstract_processing_step.AbstractProcessingStep

AbstractElementwiseTransformStep class is used to iterate over all Semantic Elements with or without applying transformations.

_NUM_ITERATIONS = 1

abstract _process_element(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement, context: sec_parser.processing_steps.abstract_classes.processing_context.ElementProcessingContext) → sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement

_process_element method is responsible for transforming a single semantic element into another.

It can also be utilized to simply iterate over all elements without applying any transformations.

_process_recursively(elements: list[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement], *, _context: sec_parser.processing_steps.abstract_classes.processing_context.ElementProcessingContext) → list[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement]

_process(elements: list[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement]) → list[sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement]

class sec_parser.processing_steps.top_section_manager_for_10q.ElementProcessingContext

The ElementProcessingContext class is designed to provide context information for elementwise processing steps.

iteration: int

class sec_parser.processing_steps.top_section_manager_for_10q.TopSectionTitle(html_tag: sec_parser.processing_engine.html_tag.HtmlTag, *, processing_log: sec_parser.processing_engine.processing_log.ProcessingLog | None = None, log_origin: sec_parser.processing_engine.processing_log.LogItemOrigin | None = None, level: int | None = None, section_type: sec_parser.semantic_elements.top_section_title_types.TopSectionType | None = None)

Bases: sec_parser.semantic_elements.mixins.dict_text_content_mixin.DictTextContentMixin, sec_parser.semantic_elements.top_section_start_marker.TopSectionStartMarker

The TopSectionTitle class represents the title and the beginning of a top-level section of a document. For instance, in SEC 10-Q reports, a top-level section could be “Part I, Item 3. Quantitative and Qualitative Disclosures About Market Risk.”.

classmethod create_from_element(source: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement, log_origin: sec_parser.processing_engine.processing_log.LogItemOrigin, *, level: int | None = None, section_type: sec_parser.semantic_elements.top_section_title_types.TopSectionType | None = None) → sec_parser.semantic_elements.abstract_semantic_element.AbstractLevelElement

to_dict(*, include_previews: bool = False, include_contents: bool = False) → dict[str, Any]

sec_parser.processing_steps.top_section_manager_for_10q.IDENTIFIER_TO_10Q_SECTION

sec_parser.processing_steps.top_section_manager_for_10q.InvalidTopSectionIn10Q

sec_parser.processing_steps.top_section_manager_for_10q.TopSectionType

sec_parser.processing_steps.top_section_manager_for_10q.part_pattern

sec_parser.processing_steps.top_section_manager_for_10q.item_pattern

class sec_parser.processing_steps.top_section_manager_for_10q._Candidate

section_type: sec_parser.semantic_elements.top_section_title_types.TopSectionType

element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement

class sec_parser.processing_steps.top_section_manager_for_10q.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: 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.”.

_NUM_ITERATIONS = 2

classmethod is_match_part_or_item(text: str) → bool

static match_part(text: str) → str | None

static match_item(text: str) → str | None

_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

_process_iteration_0(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement) → None

_process_iteration_1(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement) → sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement

_identify_candidate(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement) → None

_get_section_type(identifier: str) → sec_parser.semantic_elements.top_section_title_types.TopSectionType

_select_candidates() → tuple[_Candidate, Ellipsis]

_process_selected_candidates(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement) → sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement

_update_last_order_number(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement, order: float) → None

_log_order_number_not_greater(element: sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement, order: float) → None

_create_top_section_title(candidate: _Candidate) → sec_parser.semantic_elements.abstract_semantic_element.AbstractSemanticElement