ignition-incendium / incendium

📦 Package that extends and wraps Ignition scripting API

incendium

Package that extends and wraps some functions from Ignition's Scripting API.

For more information, please refer to the Wiki.

Prerequisites

Before you begin, ensure you have met the following requirements:

• You are familiar with Ignition 8.1 System Functions
• You have installed Python 2.7.18
• You have installed Java 17 and Jython 2.7.3

Installation and usage

Installing as a dependency for your scripting projects

To use incendium, you may install it with pip. It requires Python 2.7.18 or Jython 2.7.3.

python2 -m pip install incendium

Or

jython -m pip install incendium

This will install it as package to your Python installation, which will allow you to call incendium's Scripting functions from Python's REPL, and get code completion using an IDE (PyCharm or Visual Studio Code).

And to uninstall:

python2 -m pip uninstall incendium

Or

jython -m pip uninstall incendium

Using as a dependency in PyCharm

To include incendium as a dependency in PyCharm, you will need to attach it to your project.

1. Clone the repo or download from releases
2. With your project open where you want to include incendium, navigate to File > Open and select the incendium project folder
3. Choose Attach when prompted
4. Under the incendium project folder, right-click on the src/ folder and choose Mark Directory as > Sources Root

Installing incendium on your Gateway

Tip

You may use the Python in Ignition guide as reference.

As a Jython package

To install incendium as a Jython package on your Gateway, follow these steps:

1. Install Java 17
2. Install Jython 2.7.3
3. Run jython -m pip install incendium
4. Copy the incendium directory and typing.py from $JYTHON_HOME/Lib/site-packages to $IGNITION_DIR/user-lib/pylib/site-packages
5. Done

As a Python package

To install incendium as a Python package on your Gateway, follow these steps:

1. Install Python 2.7.18
2. Run python -m pip install incendium
3. Copy the incendium directory and typing.py from $PYTHON2_HOME/Lib/site-packages to $IGNITION_DIR/user-lib/pylib/site-packages
4. Done

Contributing to incendium

See CONTRIBUTING.md.

Discussions

Feel free to post your questions and/or ideas at Discussions.

Contributors

Thanks to everyone who has contributed to this project.

Up-to-date list of contributors.

License

See LICENSE.

Code of conduct

See CODE_OF_CONDUCT.md.

incendium's Issues

Add mechanism for handling concurrent DisposableConnection connections

[C]onsider maintaining a map of concurrent users in the gateway, keyed to client IDs perhaps, to prevent problems when one user exits just after a different user enters. - pturmel, December 2019 (link)

Currently if DisposableConnection were to be used concurrently, when one of the operations ends we risk breaking other operations after the connection is disabled by whomever first completes its transaction.

Use `{}` instead of `%s` in constants

ImportError: cannot import name TracebackType

Describe the bug

When I try to import incendium.db or any class from incendium.db I get the following error:

$ python
Python 2.7.18 (default, Oct 21 2021, 22:22:05)
[GCC Apple LLVM 12.0.0 (clang-1200.0.32.29)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.path.extend(['/path/to/incendium/src'])
>>> import incendium.db
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/path/to/incendium/src/incendium/db.py", line 15, in <module>
    from types import TracebackType
ImportError: cannot import name TracebackType
>>> quit()

The problem occurs because incendium.types "shadows" the built-in types module.

To Reproduce

See example above.

Expected behavior

This should not occur.

Screenshots

Additional context

Rollback flake8 from 6.0.0 to 5.0.4

pyflakes 3.0.0 removes handling of python 2.x # type: comments.

Revert 26505b8

ApplicationError inner_exception "Expected type 'Optional[Exception]', got 'IOError' instead"

Describe the bug

When we catch a Python exception, we get the following warning in PyCharm:

Expected type 'Optional[Exception]', got 'IOError' instead

To Reproduce

Sample code:

    try:
        ...
    except IOError as ex:
        raise ApplicationError(message, ex)

Expected behavior

There should be no warning.

Screenshots

Additional context

DisposableConnection retries

Break after any of the following conditions have been met:

1. Connection is Valid
2. Number of retries has been reached

Additionally, raise an Exception if the connection could not be enabled.

[In|Out]Param name_or_index warning "Expected type 'Union[int, str]', got 'unicode' instead"

Describe the bug

When importing unicode_literals from __future__ we get the following warning in PyCharm.

Expected type 'Union[int, str]', got 'unicode' instead

We should change the type from Union[int, str] to Union[int, str, unicode].

To Reproduce

Sample code:

    params = [
        InParam("base_id", system.db.NVARCHAR, base_id)
    ]

Expected behavior

This warning should be mitigated.

Screenshots

Additional context