GateNLP/python-gatenlp

GateWorker: consider using pythonic method names

Closed this issue · 2 comments

johann-petrak commented

Currently we use the same names as in the Java PythonWorker class, e.g. getCorpusNames, but Python linters and other code quality checkers flag those as not conforming to PEP.

So maybe we should map these to pythonic get_corpus_names etc?

johann-petrak commented

Pro: all the automated tools for code quality (pylint etc) complain about the Java-style names. This either pollutes the output and decreases the code quality score or, if disabled, we may miss code where this is actually a problem.

Con: these are the exact same name as for the actual Java method that gets run implemented in
https://github.com/GateNLP/gateplugin-Python/blob/main/src/main/java/gate/plugin/python/PythonWorker.java
so using a different name feels wrong.

johann-petrak commented

For now we leave the original Java names and disable the Pylint checking for this in just that module.