Refactor warnings and CityJSON version checking - Githubissues

cityjson / cjio

CityJSON/io: Python CLI to process and manipulate CityJSON files

MIT License

125 stars 32 forks source link

Refactor warnings and CityJSON version checking #143

Closed balazsdukai closed 2 years ago

balazsdukai commented 2 years ago

This PR is a mix of a few related changes.

Three things are refactored:

The CityJSON version verification is moved to the CityJSON.check_version method. This makes it easier to incorporate the cityjson parsing logic into other applications that import cjio.
Remove the click-dependent print_cmd_* warnings from the CityJSON methods and add a new warning system.
Prefixed the exceptions with CJ

The new warning system:

errors.CJWarning is the new warning class https://github.com/cityjson/cjio/compare/develop...check-version?expand=1#diff-0b44b8f893fa10f0f8b8aa24c8353d80d149cbdf9d3d66f40cffbba75b9b5754R21-R30
issue a warning with CJWarning(<message>).warn() eg https://github.com/cityjson/cjio/compare/develop...check-version?expand=1#diff-d44b5fd731b079c54ac6e8593dc2680cbe9f7e83625689f812716f0a39e13961R420
catch and print the warnings of a function to the CLI from the cjio module eg https://github.com/cityjson/cjio/compare/develop...check-version?expand=1#diff-a01c473d7903a68c28ac73071f96eeecc72464a2f1d8269be9502026cd2ebfa0R82-R84
the cjio.print_cmd_* function are extended to also print a list of warnings.WarningMessage that are returned from warnings.catch_warnings(record=True)