src.fpml_parser Namespace Reference

Classes
class	CodeList
class	CodeListRow
class	CodingScheme
class	MergedEntity

Functions
str	get_subject_area (str entity_dir_name)
Optional[ET.Element]	find_element (ET.Element parent, str local_name)
str	find_text (ET.Element parent, str local_name, str default='')
list[ET.Element]	find_all_elements (ET.Element parent, str local_name)
CodingScheme	parse_coding_scheme (ET.Element root)
list[CodeListRow]	parse_rows (ET.Element root, CodingScheme coding_scheme, str source_file)
CodeList	parse_xml_file (Path file_path)
tuple[str, str]	derive_entity_name (str directory_name)
MergedEntity	process_entity (Path input_dir, str entity_name)
dict	load_manifest (Path manifest_path)
str	load_methodology_text (Path methodology_path)
	generate_catalog_sql (dict manifest, Path output_path)
	generate_methodology_sql (dict manifest, str methodology_text, Path output_path)
	generate_coding_schemes_dataset_sql (dict manifest, Path output_path)
	generate_dataset_dependency_sql (dict manifest, Path output_path)
	generate_fpml_sql (Path output_dir, list[str] dataset_files, list[str] artefact_files)
	generate_coding_schemes_sql (list[MergedEntity] entities, Path output_path)
	generate_entity_model (MergedEntity entity, Path output_dir)
	generate_populate_data (MergedEntity entity, Path output_dir)
	main ()

Variables
str	GCL_NS = '{http://docs.oasis-open.org/codelist/ns/genericode/1.0/}'
str	DOC_NS = '{http://www.fpml.org/coding-scheme/documentation}'
dict	NAMESPACES
dict	ENTITY_SUBJECT_AREA_MAP
dict	ENTITY_FILE_PATTERNS
dict	NON_ISO_CURRENCY_ENRICHMENT
dict	ENTITIES_WITH_SHARED_TABLES

Detailed Description

FPML Genericode XML Parser

Parses FPML coding scheme XML files (OASIS Genericode format) and generates:
1. JSON entity models for SQL schema generation
2. SQL populate scripts for reference data
3. Coding scheme entries for dq_coding_schemes_tbl

Usage:
    python fpml_parser.py <input_dir> <output_dir> [--coding-schemes-only]

The parser handles directories with multiple XML files by merging them,
tracking the source coding scheme for each row.

Function Documentation

get_subject_area()

str get_subject_area

(

str

entity_dir_name

)

Get the subject area for an entity based on its directory name.

Here is the caller graph for this function:

find_element()

Optional[ET.Element] find_element	(	ET.Element	parent,
		str	local_name
	)

Find element by local name, handling both namespaced and non-namespaced elements.

Here is the caller graph for this function:

find_text()

str find_text	(	ET.Element	parent,
		str	local_name,
		str	default = ''
	)

Find element text by local name.

Here is the caller graph for this function:

find_all_elements()

list[ET.Element] find_all_elements	(	ET.Element	parent,
		str	local_name
	)

Find all elements by local name.

Here is the caller graph for this function:

parse_coding_scheme()

CodingScheme parse_coding_scheme

(

ET.Element

root

)

Extract coding scheme metadata from XML root element.

Here is the caller graph for this function:

parse_rows()

list[CodeListRow] parse_rows	(	ET.Element	root,
		CodingScheme	coding_scheme,
		str	source_file
	)

Extract code list rows from XML root element.

Here is the caller graph for this function:

parse_xml_file()

CodeList parse_xml_file

(

Path

file_path

)

Parse a single FPML XML file.

Here is the caller graph for this function:

derive_entity_name()

tuple[str, str] derive_entity_name

(

str

directory_name

)

Derive singular and plural entity names from directory name.

Examples:
    party-roles -> (party_role, party_roles)
    business-centres -> (business_centre, business_centres)
    entity-classifications -> (entity_classification, entity_classifications)

Here is the caller graph for this function:

process_entity()

MergedEntity process_entity	(	Path	input_dir,
		str	entity_name
	)

Process FPML XML files for a given entity from a flat directory.

Uses ENTITY_FILE_PATTERNS to find matching files.
If multiple files exist, merge them tracking each row's source coding scheme.

Here is the caller graph for this function:

load_manifest()

dict load_manifest

(

Path

manifest_path

)

Load the data manifest JSON file.

Here is the caller graph for this function:

load_methodology_text()

str load_methodology_text

(

Path

methodology_path

)

Load the methodology text file.

Here is the caller graph for this function:

generate_catalog_sql()

generate_catalog_sql	(	dict	manifest,
		Path	output_path
	)

Generate SQL file with catalog upsert from manifest.

Here is the caller graph for this function:

generate_methodology_sql()

generate_methodology_sql	(	dict	manifest,
		str	methodology_text,
		Path	output_path
	)

Generate SQL file with methodology upsert from manifest.

Here is the caller graph for this function:

generate_coding_schemes_dataset_sql()

generate_coding_schemes_dataset_sql	(	dict	manifest,
		Path	output_path
	)

Generate SQL file with coding schemes dataset upsert from manifest.

Here is the caller graph for this function:

generate_dataset_dependency_sql()

generate_dataset_dependency_sql	(	dict	manifest,
		Path	output_path
	)

Generate SQL file with dataset dependency upserts from manifest.

Here is the caller graph for this function:

generate_fpml_sql()

generate_fpml_sql	(	Path	output_dir,
		list[str]	dataset_files,
		list[str]	artefact_files
	)

Generate populate_fpml.sql master include file with all FPML files in correct order.

Here is the caller graph for this function:

generate_coding_schemes_sql()

generate_coding_schemes_sql	(	list[MergedEntity]	entities,
		Path	output_path
	)

Generate SQL file with coding scheme artefact inserts.

Here is the caller graph for this function:

generate_entity_model()

generate_entity_model	(	MergedEntity	entity,
		Path	output_dir
	)

Generate JSON model file for entity schema generation.

Here is the caller graph for this function:

generate_populate_data()

generate_populate_data	(	MergedEntity	entity,
		Path	output_dir
	)

Generate JSON data files for populate script generation.

Generates one file per coding scheme/dataset. For entities with multiple
coding schemes, multiple files are created.

Here is the caller graph for this function:

Variable Documentation

NAMESPACES

dict NAMESPACES

Initial value:

=  {
    'gcl': 'http://docs.oasis-open.org/codelist/ns/genericode/1.0/',
    'doc': 'http://www.fpml.org/coding-scheme/documentation',
}

ENTITY_SUBJECT_AREA_MAP

dict ENTITY_SUBJECT_AREA_MAP

Initial value:

=  {
    # Parties - party identification and classification
    'party-roles': 'Parties',
    'person-roles': 'Parties',
    'party-relationships': 'Parties',
    'entity-classifications': 'Parties',
    # Trading - trading infrastructure
    'account-types': 'Trading',
    'business-centres': 'Trading',
    'business-processes': 'Trading',
    'cashflow-types': 'Trading',
    # Market Data - asset and benchmark reference
    'asset-classes': 'Market Data',
    'asset-measures': 'Market Data',
    'benchmark-rates': 'Market Data',
    # Regulatory - regulatory bodies and regimes
    'local-jurisdictions': 'Regulatory',
    'regulatory-corporate-sectors': 'Regulatory',
    'reporting-regimes': 'Regulatory',
    'supervisory-bodies': 'Regulatory',
    # Currencies - currency codes
    'non-iso-currencies': 'Currencies',
}

ENTITY_FILE_PATTERNS

dict ENTITY_FILE_PATTERNS

Initial value:

=  {
    'account-types': ['account-type-*.xml'],
    'asset-classes': ['asset-class-*.xml'],
    'asset-measures': ['asset-measure-*.xml'],
    'benchmark-rates': ['benchmark-rate-*.xml'],
    'business-centres': ['business-center-*.xml'],
    'business-processes': ['business-process-*.xml'],
    'cashflow-types': ['cashflow-type-*.xml'],
    'entity-classifications': ['entity-type-*.xml', 'cftc-entity-classification-*.xml', 'cftc-organization-type-*.xml'],
    'local-jurisdictions': ['local-jurisdiction-*.xml'],
    'non-iso-currencies': ['non-iso-currency-*.xml'],
    'party-relationships': ['party-relationship-type-*.xml', 'hkma-rewrite-party-relationship-type-*.xml'],
    'party-roles': ['party-role-*.xml'],
    'person-roles': ['person-role-*.xml'],
    'regulatory-corporate-sectors': ['regulatory-corporate-sector-*.xml', 'hkma-rewrite-regulatory-corporate-sector-*.xml'],
    'reporting-regimes': ['reporting-regime-*.xml'],
    'supervisory-bodies': ['supervisory-body-*.xml'],
}

ENTITIES_WITH_SHARED_TABLES

dict ENTITIES_WITH_SHARED_TABLES

Initial value:

=  {
    'non-iso-currencies': {
        'artefact_type': 'currencies',
        'artefact_table': 'dq_currencies_artefact_tbl',
        'production_table': 'refdata_currencies_tbl',
        'populate_function': 'dq_currencies_publish_fn',
        'skip_schema_generation': True,
    }
}