Remove the OMC API functions #276

Activity

1. adeas31

   added

   enhancement

   on Apr 30, 2025
2. adeas31

   added this to the 3.8.0This milestone has been deleted milestone on Apr 30, 2025
3. adeas31

   added the

   Task

   issue type on Apr 30, 2025
4. syntron commented on May 3, 2025

   

   syntron

   on May 3, 2025

   Contributor

   More actions

   PR #282 prepares this; it removes all dependencies on OMCSessionBase - currently it keeps the code alive as OMCSessionCmd but if needed, this part can be removed

   I have no feelings regarding this as I do not use the interface provided here ...

   The main point to keep it would be that besides 4 function it is quite simple code now. The functions are:

   • getClassComment() - pyparsing.ParseException should be handled in sendExpression()
   • getParameterNames() - additional check for KeyError needed?
   • getParameterValue() - pyparsing.ParseException should be handled in sendExpression()
   • getNthComponentModification() - ???
5. casella commented on Jun 2, 2025

   

   casella

   on Jun 2, 2025

   More actions

   Write now we have created wrapper functions for each OMC API. It is very difficult to keep track of API changes. OMPython is not directly linked with OMC so it is not possible to generate these wrapper functions automatically.

   I suggest we remove these wrapper functions and clean up the code. The user can still call OMC API using sendExpression.

   @adeas31 is this backwards compatible? What happens to existing code using OMPython?
6. adeas31

   modified the milestones: 3.8.0This milestone has been deleted, 4.1.0This milestone has been deleted on Jun 17, 2025
7. adeas31 commented on Jun 17, 2025

   

   adeas31

   on Jun 17, 2025

   MemberAuthor

   More actions

   Write now we have created wrapper functions for each OMC API. It is very difficult to keep track of API changes. OMPython is not directly linked with OMC so it is not possible to generate these wrapper functions automatically.
   I suggest we remove these wrapper functions and clean up the code. The user can still call OMC API using sendExpression.

   @adeas31 is this backwards compatible? What happens to existing code using OMPython?

   It will not be backwards compatible. Any script using these functions will not work.

   At some time we need to take that jump. OMPython depends on OMC but is not directly linked to it. So we have hard coded all the OMC API functions which means there is no way to know if OMPython is broken because of a change in OMC API.
8. syntron commented on Nov 16, 2025

   

   syntron

   on Nov 16, 2025

   Contributor

   More actions

   would this project a source for the OMC API? https://github.com/ijknabla/OpenModelicaCompilerForPython

   I'm quite unsure about the relation to OMPython ...
9. adeas31 commented on Nov 17, 2025

   

   adeas31

   on Nov 17, 2025

   MemberAuthor

   More actions

   would this project a source for the OMC API? https://github.com/ijknabla/OpenModelicaCompilerForPython

   No. This is not the source of OMC API. I have never seen this project before.
   OMC API is located here https://github.com/OpenModelica/OpenModelica/blob/master/OMCompiler/Compiler/FrontEnd/ModelicaBuiltin.mo
10. casella commented on Nov 17, 2025

    

    casella

    on Nov 17, 2025

    More actions

    Interesting. I was also not aware of that.
11. syntron commented on Nov 17, 2025

    

    syntron

    on Nov 17, 2025

    Contributor

    More actions

    There seems to be some conversion of the OMC API into a yaml file which then is used to create the matching Python code - this looks like a (semi?) automated way to (re)create the OMC API in Python ...
12. adeas31

    added this to OMPython Release 5.0.0 planon Dec 1, 2025
13. github-project-automation

    moved this to Backlog in OMPython Release 5.0.0 planon Dec 1, 2025
14. adeas31

    removed this from OMPython Release 5.0.0 planon Dec 1, 2025
15. adeas31

    modified the milestones: 4.1.0This milestone has been deleted, 5.0.0 on Dec 16, 2025
16. syntron

    added a commit that references this issue on Feb 8, 2026

    remove old OMCSessionCmd; see PR OpenModelica#276

    638c175