makepy: support for enums and type-hints by tobias-loew · Pull Request #1364 · mhammond/pywin32

tobias-loew · 2019-06-28T11:22:32Z

Hi,
I've added command flags to generate enum and type-hints.
I've tested it with a quite large typelib (generated py-file has > 100k lines) and it seems to work.
Regarding the enums: there's also code for creating "Enums" (instead of "IntEnums"; use createEnums == 1) but a could find a way to make properties working without either putting a runtime penalty on everyone or breaking the ABI in init.py. Maybe you've got an idea!
Tobias

Hi, I've added command flags to generate enum and type-hints. I've tested it with a quite large typelib (generated py-file has > 100k lines) and it seems to work. Regarding the enums: there's also code for creating "Enums" (instead of "IntEnums"; use createEnums == 1) but a could find a way to make properties working without either putting a runtime penalty on everyone or breaking the ABI in __init__.py. Maybe you've got an idea! Tobias

thopiekar · 2019-07-21T21:07:04Z

Hello @tobias-loew !
Thank you for your contribution. 👍

Can you tell us which typelib has been used to test your work? Work be great to know to be able to reproduce your work.
Additionally, I still see some commented out lines in your code. Is there still some work to do to finish your PR? Are these to-dos you want to fix in the future?

Thanks! 🙂

tobias-loew · 2019-07-22T07:23:33Z

Hi,
sorry for the commented code - I'll have a look at it.
I tested the extension with EbsOpen.tlb (in attached EbsOpen.zip), the COM-Library of the product I'm the lead developer (EBSILONProfessional, www.ebsilon.com)
EbsOpen.zip

mhammond

Sorry for the delay. Can you please give some examples of the output this generates? It's difficult to read given all the 2to3 changes here, which I'd prefer to not be part of this patch (although I really should make python 2.7 compatible changes to the entire tree)

removed unused option from command line help

tobias-loew · 2019-09-11T07:51:23Z

I've import the "Microsoft Scripting Runtime" three times: the old way, with enums and with enums & typehints.
ScriptingRuntime.zip

And here is the imported "with enums and typehints" version of EbsOpen.py (the product I develop)
EbsOpen.zip

tobias-loew · 2019-09-16T08:49:04Z

The extension for enums and type-hints require Python 3. So, all changes here target only Python 3.
I'm not a Python expert, so I don't know how to (if possible) hide code from Python 2.

CarliJoy · 2020-11-14T21:48:44Z

@tobias-loew to hide code from Python 2 use:

import sys
if sys.version_info >= (3, 0):
  your_python_3_code()

@mhammond given that version 300 was just released, the problems with 2to3 changes should be resolved or?

mhammond · 2020-11-15T13:32:23Z

@mhammond given that version 300 was just released, the problems with 2to3 changes should be resolved or?

Yes, please!

tobias-loew · 2020-11-29T09:10:03Z

I've resolved the conflicts but didn't yet have time to make the "sys.version_info >= (3, 0)" changes.

tobias-loew · 2020-11-29T09:21:47Z

IMHO the best way is to add an additional option to support the generation of files with enums for version 3 AND the old style for version 2.
Thus, python 3- only users won't have to suffer from the runtime overhead.
Any objections?

CarliJoy · 2020-11-29T11:04:03Z

Python 2 is not supported anymore. You can drop any Python 2 code.
Also pywin32 droppped Python 2 support beginning with Version 300. So you can simply ignore Python 2.
We just have to find out why test test are failing (currently Github has troubles downloading the log for me)

kxrob · 2020-11-29T15:47:16Z

We just have to find out why test test are failing (currently Github has troubles downloading the log for me)

Thats because of the deprecated "::set-env" command in the github CI runner - since 2 weeks or so. A fix is already in #1622 (patch github CI: Fix broken "::set-env". Use the new $GITHUB_ENV ) since some time. But @mhammond seems not to be around currently.

tobias-loew · 2020-11-29T17:16:52Z

I made a local branch with the setenv-fix: all tests (but one that seems to hang) passed (https://github.com/tobias-loew/pywin32/actions/runs/390146137)

mhammond

I had a quick look as I'm very busy at the moment, so might take some time to get back to this. I can't even remember what's in the .zip file you attached previously, but I do note that this really needs some comments - eg, what exactly is an enum in this context? What is a type-hint? When would I want to enable those options? When would I not want to enable those options? How is the large NativeTypeMap object used, etc? Ideally we'd also have tests, maybe by abusing PyCOMTest.idl?

mhammond · 2020-11-30T04:45:33Z

@@ -0,0 +1,33 @@
+"""Contains RelaxedIntEnum
+
+This module is used by modules build by @makepy@ using enums.


nit - "built"

mhammond · 2020-11-30T04:58:48Z

 	typename = "DispatchItem"

-	def __init__(self, typeinfo=None, attr=None, doc=None, bForUser=1):
+	def __init__(self, typeinfo=None, attr=None, doc=None, bForUser=1, iCreateEnums=0):


I'm not a huge fan of iCreateEnums - it looks everywhere like it's actually a bool, except in one place where magic values of 1 and 2 are used. ISTM an - err - enum would make sense here?

mhammond · 2020-11-30T05:03:45Z

  return None

-def BuildCallList(fdesc, names, defNamedOptArg, defNamedNotOptArg, defUnnamedArg, defOutArg, is_comment = False):
+def BuildCallList(fdesc, names, defNamedOptArg, defNamedNotOptArg, defUnnamedArg, defOutArg, is_comment = False, bTypeHints = 0):


Please use False as the default.

updated VS 6-project to VS 2019

mhammond · 2021-09-05T02:04:33Z

Thanks for the contribution, and feel free to reopen this if you end up making the requested changes.

tobias-loew · 2022-07-01T13:34:42Z

Hi Mark,

I've seen your currently working on the project, so let me pick up the pieces from 2 years ago and answer your questions:

What's an enum in this context?
It's a IDL enum (i.e. a C++ unscoped enum) on the COM-side (https://docs.microsoft.com/en-us/windows/win32/midl/enum). And for Python it's either a native python-enum (https://docs.python.org/3/library/enum.html) or it's a "relaxed" python enum that adds unknown values on the fly (see implementation in RelaxedIntEnum.py)
Type-hints are defined here https://peps.python.org/pep-0484/ and come in very handy when working with large libraries
The NativeTypeMap is needed to generate the appropriate type-hints for COM-automation types
some words on iCreateEnums:
- Python-enums started with version 3.4, but versions before have to be supported, so enum-generation is an opt-in (same for type-hints). That's also the reason I didn't use an enum for iCreateEnums.
- Why the hell are there two different enum-generation options (apart from "no enums" iCreateEnums == 0)?
  - option iCreateEnums == 1 generates native Python enums. But there is an issue: a COM method may be called with a value for an enum that is not among the "known" values. The Python-enum will throw an exception in that case. Which may be good or not. It depends on, what the user expects. So, there is also
  - option iCreateEnums == 2, which creates "RelaxedIntEnum"s which simply add unknown values to their internal map and don't throw.
The CLI currently only allows to select option 2, but this could be changed easily.

I adopted my changes to the new main branch. In case your still interested in these changes, I think it would be best to open a new PR on main.

best
Tobias

tobias-loew added 3 commits June 28, 2019 13:18

Update genpy.py

c0d7989

added RelaxedIntEnum

1fc6ff1

mhammond requested changes Sep 8, 2019

View reviewed changes

tobias-loew and others added 2 commits September 11, 2019 09:35

Update makepy.py

e4177af

removed unused option from command line help

Update makepy.py

59b9a0e

removed unused option from command line help

Merge branch 'master' of https://github.com/tobias-loew/pywin32

f6c430c

Merge remote-tracking branch 'remotes/upstream/master'

3f1fb00

fixed merge

d777a51

mhammond reviewed Nov 30, 2020

View reviewed changes

tobias-loew added 3 commits December 1, 2020 08:36

Merge remote-tracking branch 'remotes/upstream/master'

fe878e5

Merge remote-tracking branch 'remotes/upstream/master'

222d479

added test-generation for type-hints and enums

87ff83a

updated VS 6-project to VS 2019

mhammond closed this Sep 5, 2021

tobias-loew mentioned this pull request Jul 4, 2022

makepy: support for enums and type-hints - next try #1909

Closed

		@@ -0,0 +1,33 @@
		"""Contains RelaxedIntEnum

		This module is used by modules build by @makepy@ using enums.

Conversation

tobias-loew commented Jun 28, 2019

Uh oh!

thopiekar commented Jul 21, 2019

Uh oh!

tobias-loew commented Jul 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mhammond left a comment

Choose a reason for hiding this comment

Uh oh!

tobias-loew commented Sep 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tobias-loew commented Sep 16, 2019

Uh oh!

CarliJoy commented Nov 14, 2020

Uh oh!

mhammond commented Nov 15, 2020

Uh oh!

tobias-loew commented Nov 29, 2020

Uh oh!

tobias-loew commented Nov 29, 2020

Uh oh!

CarliJoy commented Nov 29, 2020

Uh oh!

kxrob commented Nov 29, 2020

Uh oh!

tobias-loew commented Nov 29, 2020

Uh oh!

mhammond left a comment

Choose a reason for hiding this comment

Uh oh!

mhammond Nov 30, 2020

Choose a reason for hiding this comment

Uh oh!

mhammond Nov 30, 2020

Choose a reason for hiding this comment

Uh oh!

mhammond Nov 30, 2020

Choose a reason for hiding this comment

Uh oh!

mhammond commented Sep 5, 2021

Uh oh!

tobias-loew commented Jul 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tobias-loew commented Jul 22, 2019 •

edited

Loading

tobias-loew commented Sep 11, 2019 •

edited

Loading