kojiromike opened a new pull request #1270:
URL: https://github.com/apache/avro/pull/1270
Improves the python cli, consisting mainly of scripts/avro and avro.tool, by
implementing argparse, and a `__main__.py` module.
- argparse handles arity and type exceptions more fluently at invocation
time than can easily be done with sys.argv.
- argparse handles sub-commands natively, especially in python 3.7 and up.
- `__main__.py` dispatch (along with setuptools
`entry_points.console_scripts` at install time) allows the cli to be invoked
with both `python -m avro` and just `avro` without having an out-of-band
`scripts/avro` directory.
- Just in case someone is still using scripts/avro, I've kept that around
with a deprecation warning.
- I added type hints as best I can; however, there are some gray areas with
the CLI:
- avro prefers its fileIO to be bytes, but the standardio are text.
- The avro script has an `eval` call that we might want to get rid of,
some day.
I'm not sure why we have both avro.tool and avro. We may want to converge on
a single avro entrypoint.
### Jira
- [ ] My PR addresses the following [Avro
Jira](https://issues.apache.org/jira/browse/AVRO/) issues and references them
in the PR title. For example, "AVRO-1234: My Avro PR"
- https://issues.apache.org/jira/browse/AVRO-XXX
- In case you are adding a dependency, check if the license complies with
the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
### Tests
- [ ] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
### Commits
- [ ] My commits all reference Jira issues in their subject lines. In
addition, my commits follow the guidelines from "[How to write a good git
commit message](https://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
- [ ] In case of new functionality, my PR adds documentation that describes
how to use it.
- All the public functions and the classes in the PR contain Javadoc that
explain what it does
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
