ZXBasic fails to run as a console script

[kosarev]

The problem seems to be that the zxb.py in the root directory effectively imports itself on import zxb. Looks like either the script or the same-named package needs to be renamed? Or, you could just remove the script and let the package do its work.

To reproduce:

$ python3 setup.py develop --prefix ~/.local
$ zxb
Traceback (most recent call last):
  File "/home/kosarev/.local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2451, in resolve
    return functools.reduce(getattr, self.attrs, module)
AttributeError: module 'zxb' has no attribute 'main'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/kosarev/.local/bin/zxb", line 11, in <module>
    load_entry_point('zxbasic', 'console_scripts', 'zxb')()
  File "/home/kosarev/.local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 489, in load_entry_point
    return get_distribution(dist).load_entry_point(group, name)
  File "/home/kosarev/.local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2852, in load_entry_point
    return ep.load()
  File "/home/kosarev/.local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2443, in load
    return self.resolve()
  File "/home/kosarev/.local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2453, in resolve
    raise ImportError(str(exc))
ImportError: module 'zxb' has no attribute 'main'

[boriel]

Yes, setup.py script is outdated!
Will update it, but I'm seriously considering to abandon it.

[boriel]

Now you can run it with zxbc or zxb.
Try it and reopen if it fails :)

[kosarev]

The patch doesn't seem to work because the zxb.py hiding the zxb package is still in place. This prevents the zx emulator to import the zxb package when run as a console script, so I have to run it as python3 -m zx circle.zxb, which is extra typing comparing to the usual zx circle.zxb.

Besides, I was hoping the entry_points clause in setup.py will survive so people could just do zxb whatever.bas and get the image.

[boriel]

I wanted to tidy up the directory a bit, so zxb, zxbasm and zxbpp have in their respective folders, whilst leaving the original zxb.py, zxbasm.py and zxbpp.py scripts in the root folder so they can be used as before.

For what you mention, to use zxb from a script, this should work, since it's the way the testing framework tests the compiler.

See:
https://github.com/boriel/zxbasic/blob/master/tests/functional/test.py#L365

How are you invoking the compiler?
Can you post a snippet or guide me to the repo file which is failing?

[boriel]

Ah, one more thing:

zxb is deprecated (still works) in favour of zxbc.
And zxb module will be renamed to frontend.

All of this refactors are on the road to ZX Basic 2.x which will include a linker and different target-backends.

[kosarev]

How are you invoking the compiler?

It works when run as a normal Python script and fails when run as a console script via a setup.py's entry point. Please see attached. Here are the steps to reproduce:

$ python3 setup.py develop --prefix ~/.local
$ zxb_client
Traceback (most recent call last):
  File "/home/kosarev/.local/bin/zxb_client", line 11, in <module>
    load_entry_point('zxb-client', 'console_scripts', 'zxb_client')()
  File "/home/kosarev/labs/kosarev/github/zx/lab/console/zxb_client.py", line 7, in main
    zxb.main()
AttributeError: module 'zxb' has no attribute 'main'

zxb_client.zip

[boriel]

Yes, console scripts were removed.
Use just scripts entry that are located in bin/.

The new setup.py uses these:
https://github.com/boriel/zxbasic/blob/master/setup.py#L28

Wiil it work for you with these scripts?

EDIT: so with this change, typing zxb or zxbasm from the cmdline should work.
If you need to call zxb.main() maybe we can workaround it (i.e. renaming the zxb/ package to something else like frontend/)

[kosarev]

I think from the zx emulator I can only import the compiler as a package, that is, by invoking import zxb, so it's not really about running it from the command line. Here's how it's currently implemented:
kosarev/zx@c837fbd#diff-93fabf1b822af63dc933d7d7238b8939R27

Yes, I'd expect one of the zxb.py module or the zxb package be renamed or the zxb.py removed, and the console entry points definitions in setup.py brought back. That should resolve the problem, if I'm not missing anything.

[boriel]

Ok. I'll have a look.

BTW the provided zxb_client.py works ok with the current project status (master branch).

[kosarev]

Hmm. Somehow it fails on my machine with the traceback as shown above. Are you sure you run it as zxb_client and not as zxb_client.py?