Describe the bug
Should AlarmQueryResultImpl inherit from List?

https://github.com/ignition-api/8.1-stubs/blob/895288e8b0e1f61a0d9c826b16a674ebd53c12cd/stubs/com/inductiveautomation/ignition/common/alarming/query/__init__.pyi#L7-L10

To Reproduce

results = system.alarm.queryStatus(state=["ActiveUnacked", "ActiveAcked"], all_properties = props)
for x in range(len(results)):
    print(results[x])

Argument of type "AlarmQueryResultImpl" cannot be assigned to parameter "obj" of type "Sized" in function "len"
  "AlarmQueryResultImpl" is incompatible with protocol "Sized"
    "__len__" is not present

"__getitem__" method not defined on type "AlarmQueryResultImpl"

Expected behavior
No type error for working code.

Is your feature request related to a problem? Please describe.

See ignition-devs/ignition-api-8.1-stubs#26

Describe the solution you'd like

Add type hints to java.net.Socket functions

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

In some scripts, the end-user might want to check the scope of the application. In order to accomplish this they might use ApplicationScope.

See here: https://forum.inductiveautomation.com/t/detect-vision-or-perspective/44636/2?u=thecesrom

Describe the solution you'd like

Add ApplicationScope under com.inductiveautomation.common.model

Describe alternatives you've considered

Additional context

Describe the bug

See: ignition-devs/ignition-api-8.1-stubs#19

To Reproduce

Expected behavior

Screenshots

Additional context

Describe the bug
When we import system.tag on PyCharm's Python Console or IDLE we get the following error:

$ python                                     
Python 2.7.18 (default, Dec 29 2022, 09:23:27) 
[GCC Apple LLVM 14.0.0 (clang-1400.0.29.202)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import system.tag
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/thecesrom/.venvs/SCADA/lib/python2.7/site-packages/system/tag.py", line 43, in <module>
    from com.inductiveautomation.ignition.common.browsing import Results
  File "/Users/thecesrom/.venvs/SCADA/lib/python2.7/site-packages/com/inductiveautomation/ignition/common/browsing/__init__.py", line 9, in <module>
    from com.inductiveautomation.ignition.common.model.values import QualityCode
  File "/Users/thecesrom/.venvs/SCADA/lib/python2.7/site-packages/com/inductiveautomation/ignition/common/model/__init__.py", line 11, in <module>
    from com.inductiveautomation.ignition.common.tags.model import TagManager
  File "/Users/thecesrom/.venvs/SCADA/lib/python2.7/site-packages/com/inductiveautomation/ignition/common/tags/model/__init__.py", line 6, in <module>
    from com.inductiveautomation.ignition.common.browsing import BrowseFilter
ImportError: cannot import name BrowseFilter

To Reproduce

Install ignition-api on a Python2 virtual environment, and import system.tag on an interactive session (IDLE).

Expected behavior

It should run without issues.

Screenshots

Additional context

Affected versions: 8.1.24.post6, 8.1.25.post6, 8.1.26.post2, 8.1.27, 8.1.28, 8.1.29, 8.1.30.

Ref: https://github.com/orgs/ignition-api/discussions/8, originally reported by @golf-n-code

Is your feature request related to a problem? Please describe.

When using smtpProfile smtp, username and password keyword arguments are ignored; the only "truly" required argument is fromAddr.

Describe the solution you'd like

Mark smtp as optional.

Describe alternatives you've considered

Additional context

Describe the bug

When importing the following system modules on PyCharm's Python Console, I get an ImportError exception.

To Reproduce

Open PyCharm's Python Console on a project which depends on ignition-api/8.1 and import any of the following system modules:

• alarm
• dataset
• db
• device
• eam
• gui
• nav
• opc
• opchda
• perspective
• report
• roster
• secsgem
• sfc
• tag
• twilio
• user
• util

Expected behavior

There should be no error.

Screenshots

Additional context

This is caused by a circular import that goes undetected by pylint.

Is your feature request related to a problem? Please describe.

The GridLayout class is missing from the java.awt package.

Describe the solution you'd like

Add it.

Describe alternatives you've considered

None.

Additional context

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Add MongoDB functions.

Describe alternatives you've considered

Additional context

https://docs.inductiveautomation.com/display/DOC81/system.mongodb

Is your feature request related to a problem? Please describe.

No. This feature is new in Ignition version 8.1.32.

Describe the solution you'd like

Add the function.

Describe alternatives you've considered

None.

Additional context

https://docs.inductiveautomation.com/display/DOC81/system.bacnet.writeRawMultiple

Is your feature request related to a problem? Please describe.

See: ignition-devs/ignition-api-8.1-stubs#77

Describe the solution you'd like

Create type aliases for numeric unions.

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

Feature request.

Describe the solution you'd like

Add all classes implementing TagPath.

Describe alternatives you've considered

Additional context

Ref: #104

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

Revert bc77f15

Is your feature request related to a problem? Please describe.

With the latest changes to JythonSequence's __iter__ type hints we are getting the following error in incendium:

$ mypy --py2 src
src/incendium/dataset.py:152: error: Invalid index type "Union[str, unicode]" for "PyObject"; expected type "Union[int, PyObject]"
src/incendium/dataset.py:154: error: Invalid index type "Union[str, unicode]" for "PyObject"; expected type "Union[int, PyObject]"
Found 2 errors in 1 file (checked 16 source files)

Describe the solution you'd like

We believe Iterator[PyObject], while accurate, should be changed to Iterator[Any].

Describe the bug

When running mypy with the strict flag, we get the following error:

error: Call to untyped function "getPassword" in typed context

To Reproduce

Implement JPasswordFiled.getPassword() and run mypy

Expected behavior

It should not produce an error

Screenshots

Additional context

Ref: ignition-devs/ignition-api-8.1-stubs#102

Is your feature request related to a problem? Please describe.

In certain modules, when unicode_literals is imported from __future__ PyCharm warns our users about potentially passing the "wrong" type.

Describe the solution you'd like

Change from:

def getOutParamValue(self, param: Union[int, str]) -> Any: ...
def registerInParam(
    self, param: Union[int, str], typeCode: int, value: Any
 ) -> None: ...
def registerOutParam(self, param: Union[int, str], typeCode: int) -> None: ...

To:

def getOutParamValue(self, param: Union[int, String]) -> Any: ...
def registerInParam(
    self, param: Union[int, String], typeCode: int, value: Any
 ) -> None: ...
def registerOutParam(self, param: Union[int, String], typeCode: int) -> None: ...

Since String is an alias for Union[str, unicode].

Describe alternatives you've considered

Additional context

See ignition-devs/incendium#64

Is your feature request related to a problem? Please describe.

These class aliases were "necessary" before we added type hints. Now with type hints these are not required as they pollute the stubs package.

Describe the solution you'd like

Take system.util lines 72-73:

PyDataSet = DatasetUtilities.PyDataSet
RequestImpl = SystemUtilities.RequestImpl

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

When I run mypy against incendium I get the following errors regarding system.db constants:

$ mypy src
src/incendium/db.py:166: error: Module has no attribute "INTEGER"
src/incendium/db.py:253: error: Module has no attribute "BIT"

Describe the solution you'd like

In order to make those constants available on ignition-api-stubs, all constants must be added to __all__.

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

New in 8.1.24

Additional context

https://docs.inductiveautomation.com/display/DOC81/system.vision.updateProject

Is your feature request related to a problem? Please describe.
For one of the projects, TagPathParser is needed since the path of a tag is important for subsequent modifications of other references.

Describe the solution you'd like
Adding the TagPathParser function from https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.21/com/inductiveautomation/ignition/common/tags/paths/parser/TagPathParser.html#%3Cinit%3E()

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

New in 8.1.25

Is your feature request related to a problem? Please describe.

The JPasswordField class is missing from javax.swing package.

Describe the solution you'd like

Add it.

Describe alternatives you've considered

None.

Additional context

Is your feature request related to a problem? Please describe.

We are missing system.* constants.

Describe the solution you'd like

Add these constants.

system.print

• LANDSCAPE
• PORTRAIT

system.tag

• DEFAULT_TIMEOUT_MILLIS
• LEGACY_DEFAULT_TIMEOUT_MILLIS

system.util

• APPLET_FLAG
• CLIENT_FLAG
• DESIGNER_FLAG
• FULLSCREEN_FLAG
• MOBILE_FLAG
• PREVIEW_FLAG
• SSL_FLAG
• WEBSTART_FLAG

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

New in 8.1.20

An OPCBrowseElement’s server node ID can now be obtained using the getNodeId method call on the system.opc.browseServer function.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

New in Ignition 8.1.22

Scripting

• The system.util.setLocale system function now allows java.util.Locale objects to be passed in as parameters.

Is your feature request related to a problem? Please describe.

Some PyUser functions are missing type hints, and I get the following error when I run mypy against incendium:

$ mypy src
src/incendium/user.py:39: error: "getOrDefault" of "PyUser" does not return a value

Describe the solution you'd like

Add type hints to all PyUser functions

Describe alternatives you've considered

Additional context

Describe the bug

system.dataset.toPyDataSet and the underlying method check if the dataset is of type BasicDataset, it should accept any class implementing Dataset.

Classes implementing Dataset:

AbstractDataset, ArrayDataset, BasicDataset, BasicStreamingDataset, CacheAggregateDataset, ColumnAttributesDataSet, ColumnFilteredDataSet, DatasetUtilities.PyDataSet, JsonDataset, MutableDataset, NonSerializingDataset, OptimizedDataSet, RowFilteredDataSet, StreamingDataset, TimeMaskedDataset

To Reproduce

Anything other than an instance of BasicDataset throws the same error.

Expected behavior

Allow instance of a class which implements the Dataset interface.

Screenshots

Additional context

Describe the bug

Originally reported here: https://github.com/thecesrom/Ignition/issues/53

When we import typing at java.lang, install the package, and run python2 -m pip list we get the following error:

AttributeError: 'module' object has no attribute '_copy_dispatch'

To Reproduce

On a dev environment add type hints to java.lang, and try to install the package locally.

1. Clone the repo
2. Add type hints that would require importing the typing module
3. Install the package locally on a virtual environment
4. Run python2 -m pip list

Expected behavior

We should be able to add type hints and not get an error like this.

Screenshots

Additional context

The exception is thrown because we are mocking org.python.core and line 60 at copy.py is causing the exception:

try:
    from org.python.core import PyStringMap
except ImportError:
    PyStringMap = None

Is your feature request related to a problem? Please describe.

No. This feature is new in Ignition version 8.1.32.

Describe the solution you'd like

Add the function.

Describe alternatives you've considered

None.

Additional context

https://docs.inductiveautomation.com/display/DOC81/system.bacnet.readRawMultiple

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Describe the bug

Based on documentation, the html arg should be bool instead of Union[str, unicode, None]

To Reproduce

Expected behavior

Calling system.net.sendEmail with html set to True or False should not produce a warning by the IDE.

Screenshots

Additional context

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

I write code like this
tagR = system.tag.readBlocking(['[default]xxx/xxx/xxx/xxx'])
tagR0=tagR[0]
testValue =tagR0.getValue()
print(tagR0.getValue())
but I get the value is java.lang.object ,how to convert it to the python base type ?