Pattern_Parser.md

graph LR
    Parser_Orchestrator["Parser Orchestrator"]
    Pattern_Set_Builder["Pattern Set Builder"]
    Pattern_Collection_Manager["Pattern Collection Manager"]
    Individual_Pattern_Parser["Individual Pattern Parser"]
    Row_Parser["Row Parser"]
    Row_Connector["Row Connector"]
    ID_Manager["ID Manager"]
    Parser_Orchestrator -- "initiates creation of" --> Pattern_Set_Builder
    Parser_Orchestrator -- "directs" --> Pattern_Collection_Manager
    Pattern_Collection_Manager -- "delegates parsing to" --> Individual_Pattern_Parser
    Individual_Pattern_Parser -- "requests parsing from" --> Row_Parser
    Individual_Pattern_Parser -- "triggers" --> Row_Connector
    Individual_Pattern_Parser -- "utilizes" --> ID_Manager
    Row_Parser -- "provides delayed data to" --> Individual_Pattern_Parser
    Row_Parser -- "utilizes" --> ID_Manager

Loading

Details

The Pattern Parser subsystem is primarily encapsulated within the knittingpattern.Parser module, specifically the Parser.py file. Its core responsibility is to interpret raw input data (typically JSON objects) and transform it into a canonical, structured internal knitting pattern data model, handling validation and data enrichment.

Parser Orchestrator

Manages the overall parsing lifecycle, including initialization, state management, and providing entry points for parsing operations. It acts as the primary coordinator for the parsing process.

Related Classes/Methods:

• knittingpattern.Parser.knitting_pattern_set:76-90
• knittingpattern.Parser.__init__:40-49
• knittingpattern.Parser._start:51-58
• knittingpattern.Parser.default_parser:257-266

Pattern Set Builder

Constructs the high-level structure of the knitting pattern set, including version and type validation, ensuring the input conforms to the expected schema.

Related Classes/Methods:

• knittingpattern.Parser._create_pattern_set:247-254
• knittingpattern.Parser._get_type:231-241
• knittingpattern.Parser._error:68-74

Pattern Collection Manager

Iterates through the input data to manage the parsing of individual patterns within a larger set, delegating the detailed parsing of each pattern.

Related Classes/Methods:

• knittingpattern.Parser._fill_pattern_collection:138-143

Individual Pattern Parser

Parses the intricate details of a single knitting pattern, including its rows, and handles post-processing steps like instruction finalization and inheritance resolution.

Related Classes/Methods:

• knittingpattern.Parser._pattern:174-182
• knittingpattern.Parser.new_pattern:184-192
• knittingpattern.Parser._finish_instructions:107-112
• knittingpattern.Parser._finish_inheritance:92-97

Row Parser

Focuses on parsing individual rows and their specific elements, including marking certain data for delayed processing (e.g., instructions or inheritance that depend on other parsed elements).

Related Classes/Methods:

• knittingpattern.Parser._rows:194-199
• knittingpattern.Parser._row:145-153
• knittingpattern.Parser._delay_instructions:114-120
• knittingpattern.Parser._delay_inheritance:99-105

Row Connector

Establishes logical connections and relationships between parsed rows, crucial for building the complete pattern structure.

Related Classes/Methods:

• knittingpattern.Parser._connect_rows:201-229

ID Manager

Provides a utility for standardizing and converting elements to internal identifiers, ensuring data consistency and uniqueness within the parsed data model.

Related Classes/Methods:

• knittingpattern.Parser._to_id:60-66

FAQ