sr-murthy / oedtools Goto Github PK

• Add test coverage for CLI and report modules

Add Python type hints to source code

• Currently, validation only applies to required (mandatory) columns - the exception MissingRequiredColumnError is raised whenever a column marked R in the respective schema is missing from a specific input file for that schema - but not conditionally required (CR) columns. CR columns such as deductibles and limits in, say, a loc. file, are required if there are policy financial terms applying to the locations relating to those columns, and there are some CR columns such as deductible and limit type and code columns which depend on the existence of deductible and limit columns.

• Currently, querying the schemas (via oed columns info) does not allow querying for CR or O columns. Fixed by #11 and release 0.3.0.

The validate CLI command currently consists of separate sub-commands for validating headers (oed validate headers) and files (oed validate file). This could be simplified by removing the file subcommand entirely, and using file validation as the default option for validate (requiring just a -f option to specify the file path, with an addition --headers option required for header validation in the file.

Some custom codes for Currency and Country defined in the OED specification are rejected by the tool.

Currency: NIS (New Israeli Shekel) is rejected. Tested several historic codes which were all accepted correctly.
Country: All tested offshore codes (e.g. A1) are rejected. The other OED defined codes (XB, XE, XS, XW) are OK.

Using v0.3.2.

Extend CLI to support querying of values profile

Update required for OED version 1.1.0

ATM files which don't generate any OED errors or warnings produce the following single-line output

"path/to/file" file validation complete: no exceptions or errors

Such files should not generate any CLI output.

There is some numeric type testing in the existing utils module, e.g. is_real_number

https://github.com/sr-murthy/oedtools/blob/master/oedtools/utils.py#L189

and also get_value

https://github.com/sr-murthy/oedtools/blob/master/oedtools/utils.py#L236

which should be replaced by the use of the built-in Python numbers hierarchy provided by the numbers module

https://docs.python.org/3/library/numbers.html#numbers.Number

For example, is_real_number(<val>) could be replaced by

isinstance(<val>, numbers.Real)

and complex number checking which at the moment uses isinstance(<val>, complex) is better implemented using

isinstance(<val>, numbers.Complex)

Update required for OED version 1.0.4

• Replace references to "values profile" in documentation with "data model" (for schemas and code, the replacements are: values.csv ~> data_model.csv, values_profile.json ~> data_model.json, values_profile ~> data_model.

• Add Sphinx docs + deploy docs