search

jubnzv / iec-checker

Static analysis of IEC 61131-3 programs
GNU Lesser General Public License v3.0
63 stars 12 forks source link

Specify the Location of the OCaml Binary for `checker.py` #5

Closed engineerjoe440 closed 3 years ago

engineerjoe440 commented 3 years ago

Background:

OS: Windows 10 - x64

Python Version: 3.9.0

Contribution Concept:

During some early testing, I realized that the OCaml file would need to be placed in a specific location for the Python scripts to be able to reference it. From poking around in the .py files, it looks like the default location for the binary is: ../output/bin/iec_checker (just like what's shown in the usage example of the main README ). It seems like this could be added as an optional argument to the Python script to allow the user to specify a file path to the binary.

I think that with this added argument, it would be pretty easy for a user to execute:

$ python checker.py <files> -b <path/to/my/copy/of/the/binary/file>

or

$ python checker.py <files> --binary <path/to/my/copy/of/the/binary/file>

What do you think?

If you're not opposed, I could implement the feature in a pull request for your review. I would imagine it wouldn't take much time to perform. Would you be open to such a contribution?

jubnzv commented 3 years ago

Yes, that's a good point. Your contribution is welcome. I like the idea of passing the file path to the binary through the command line argument. Expect for the changes in the checker.py and core.py, this will require tweaking the test suite which also calls the functions from core.py to run tests.

engineerjoe440 commented 3 years ago

Forgive me for not starting on this a little sooner, but I've just made a new branch, and I'm going to open a PR in just a moment! Thanks, so much for your willingness to allow contributions! Please let me know if I've made any styling choices that you would like changed, or anything else! :)