Py runtime: Move to relative imports #4705
Conversation
pelson
force-pushed
the
feature/pyruntime-imports
branch
from
3bd8e91
to
8d82b49
Compare
|
@pelson thanks for this. LGTM apart from my 2 comments. |
|
Thanks @ericvergnaud - I think you forgot to hit submit review. Comments missing. |
| @@ -1,5 +1,11 @@ | |||
| # Generated from XPathLexer.g4 by ANTLR 4.13.1 | |||
| from antlr4 import * | |||
| from ..Lexer import Lexer | |||
There was a problem hiding this comment.
This file is generated, and generated files cannot use relative imports since they normally sit outside the antlr code base. Please revert
Signed-off-by: Phil Elson <pelson.pub@gmail.com>
pelson
force-pushed
the
feature/pyruntime-imports
branch
from
8d82b49
to
06417ca
Compare
| @@ -165,7 +164,3 @@ def process(input_stream, class_lexer, class_parser): | |||
| process(input_stream, class_lexer, class_parser) | |||
| else: | |||
| print("[ERROR] file {} not exist".format(os.path.normpath(file_name))) | |||
|
|
|||
There was a problem hiding this comment.
In general it is bad practice to run a module directly like this (e.g. via python antlr4/_pygrun.py). For example, if you do this on a file that has relative imports, you will get errors along the lines of ImportError: attempted relative import with no known parent package
pygrun is exposed as a console script in the pyproject.toml, meaning that if you install the runtime, you have an executable on the path called pygrun (including for editable installs).
This also fixes a few
from antlr4 import *, which is considered bad practice unless being done to expose an interface (https://peps.python.org/pep-0008/#imports)My changes seem to modify generated files in
antlr4.xpath. I didn't yet look at fixing the generator.There remains some significant issues withe the namespaces being exposed in the runtime - I would be happy to follow up after this change to tighten the names being made publicly available.