Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend use of custom result formatters to CLI tool #3517

Merged
merged 5 commits into from
Aug 18, 2024

Conversation

lonvia
Copy link
Member

@lonvia lonvia commented Aug 17, 2024

The API functions of the nominatim CLI tool can now also show the outputs created by custom result formatters. There is a new option --list-formats for all of them, which can be used to check, which formats are configured. This should particularly come in handy when you are writing your own formatters. In contrast to the server, the CLI tool will properly report on any exceptions in the code with the usual Python backtrace making debugging easy.

Also corrects and improves the documentation on result formatters:

  • add section about error message formatting
  • add some missing imports in the examples
  • add a hint about debugging formatters using the CLI tool
  • correct a comment that indicated that new formats must be implemented for all result types, that's simply not true

@lonvia lonvia merged commit 8b41b80 into osm-search:master Aug 18, 2024
11 checks passed
@lonvia lonvia deleted the improve-custom-formatter branch August 18, 2024 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant