Helpfile documentation as well as the syntax being used by C#/Matlab are the same, they are based on .NET.

However, when using python, we connect python with the windows application(OpticStudio) through a module named pywin32,  which is a package for Windows Extension, can provides access to many of the Windows APIs from Python. There is ‘translated’ work being done for interfaces, classes, objects and methods when connection being established using COM (or Python). And because of this, there are small part of attributes name are not mapped quite well, just as the above example shown (the upper and lower case for 'V' is not matched when compared with helpfile documentation). We are now making efforts to transit to a .NET package to eliminate the discrepancy.

For now, if Attribute error appears and you have no idea what's the correct attribute names, _prop_map_get.keys() can help, for example, by listing keys name, attribute name used in python is lower case 'value'  here.  

>>>TheMFE=TheSystem.MFE

>>>Operand1=TheMFE.GetOperandAt(1)

>>>Operand1._prop_map_get_.keys()

dict_keys(['Contribution', 'ContributionCell', 'IsActive', 'OperandNumber', 'RowColor', 'Target', 'TargetCell', 'ValueCell', 'Weight', 'WeightCell', 'type', 'typeName', 'value'])

Code completion can help to navigate the method:

Enumeration in python being imported as an object named 'constants'. So the way of naming is different from that being used in C#/Matlab. The following code can generate a excel table include all enumerations in python, you may check the table when you got errors indicate that you are using incorrect enumeration. 

from win32com.client import constants

from win32com.client import gencache

gencache.EnsureModule('{EA433010-2BAC-43C4-857C-7AEAC4A8CCE0}', 0, 1, 0)

gencache.EnsureModule('{F66684D7-AAFE-4A62-9156-FF7A7853F764}', 0, 1, 0)

a=constants.__dict__['__dicts__'][0]

string=a.keys().__str__().split(", ",-1)

# the path below should be changed to reflect your situation

fo=open("C:\\Users\\julia.zhang\\Desktop\\Attribute_name.csv","w")

for i in range(1,len(string)-3):

     fo.write("constants." + string[i].strip("'") + "\n")

fo.close()

Hi Mark,



Most programming languages, such as C++, Matlab, and Python, are case sensitive. So the ZOS-API should also be considered case sensitive. For example, the Matlab code below uses "value" instead of the API-specific "Value". 

 

TheSystem = TheApplication.PrimarySystem;

TheMFE = TheSystem.MFE;

val1 = TheMFE.GetOperandAt(3).value;

When I run this, I will get the error "No appropriate method, property, or field 'value' for class 'ZemaxUI.ZOSAPI.Editors.ZOSAPI_MFERow'." This is similar to an attribute error in Python.



The problem that Julia is describing is this: we put together the ZOS-API using the .NET interface. This means that any program connecting to the API through .NET (Matlab, C++, C#, Mathematica) will have the ZOS-API package directly installed. The syntax of the properties ("Value", "MFE", "PrimarySystem", etc.) will match the ZOS-API syntax guide exactly.



Python, on the other hand, is connected to the ZOS-API through the COM interface. Because of this, we have to use pywin32 to translate the API commands into the COM language. During this translation, the syntax of some of the properties may be carried over to COM incorrectly. For example, in OpticStudio 20.1 and 20.1.1, Python uses "value" instead of "Value". So, it's not so much that pywin is introducing case sensitivity; rather, it's introducing incorrectly formatted keywords.  



Julia has put together a brilliant way to check if the Python attribute error is caused by one of those incorrectly formatted keywords, or by some other problem in the code. I'm excited to put this code to use!

In sample python code that I believe was bundled with a release I installed on July 31st of 2019, there were references to win32com.  

In the sample python code that I have dated September 14, 202, there are references to neither win32com nor pywin32.

What has changed?  And where might I find a list of modules required for interfacing to the ZOS-API from python?