Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix __next__() in IEnum code generator #467

Merged
merged 1 commit into from
Jan 14, 2023
Merged

fix __next__() in IEnum code generator #467

merged 1 commit into from
Jan 14, 2023

Conversation

jonschz
Copy link
Contributor

@jonschz jonschz commented Jan 13, 2023 •
edited
Loading

This fixes #353, see the discussion there.

@jonschz
Copy link
Contributor Author

jonschz commented Jan 13, 2023

@junkmd Do you want me to add the test case here as well?

junkmd added a commit to junkmd/pywinauto that referenced this pull request Jan 14, 2023
@junkmd
test enthought/comtypes#467
925137a
@junkmd junkmd added the drop_py2 dev based on supporting only Python3, see #392 label Jan 14, 2023
@junkmd
Copy link
Collaborator

junkmd commented Jan 14, 2023

@jonschz

As a matter of fact, I want a test to ensure that a derived class of IUnknown which has name starts with IEnum and has methods named "Next", "Skip", "Reset", and "Clone" behaves as an Iterator.
This behavior has never been tested before.

However, for the following reasons, changing only this one line should be sufficient for the scope of this PR.

  1. Before the change, it was clearly a dead code and the cause of the error in Py3.
  2. This does not reduce coverage rate. Appveyor CI does not measure coverage, but I do it in my development environment. This change is a one-line-to-one-line and not adding conditional branches.
  3. The discussion in Iterators in generated files implementing next() instead of __next__() #353 allows us to verify that it behaves as an Iterator.
    The test code illustrated in Iterators in generated files implementing next() instead of __next__() #353 will only work if a portable device is connected to the environment.
    There are other test cases in this package that are environment-dependent and in some cases do not run, but I want to make as few as possible in the test cases we will create.
    It seems to me that there may be other COM objects that are less environment-dependent that would be more suitable than IEnumPortableDeviceObjectIDs for IEnum… is to be used for the purpose of ensuring its behavior as an Iterator.
    But I don't know of any such COM object or COM library, so I posted make tests for ensuring IEnum... in generated modules behave as a Iterator #468 as help wanted.

@junkmd
Copy link
Collaborator

junkmd commented Jan 14, 2023

CIs are passed.

memo

https://github.com/enthought/comtypes/actions/runs/3914292684/jobs/6694488613
https://ci.appveyor.com/project/cfarrow/comtypes/builds/45934073
https://ci.appveyor.com/project/pywinauto/pywinauto/builds/45936118

junkmd
junkmd approved these changes Jan 14, 2023
View reviewed changes
Copy link
Collaborator

@junkmd junkmd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@junkmd junkmd linked an issue Jan 14, 2023 that may be closed by this pull request
Iterators in generated files implementing next() instead of __next__() #353
Closed
@junkmd junkmd merged commit a76f0b1 into enthought:drop_py2 Jan 14, 2023
@junkmd junkmd modified the milestones: 1.2.0, 1.3.0 Jan 14, 2023
junkmd pushed a commit to junkmd/comtypes that referenced this pull request Feb 4, 2024
@jonschz @junkmd
fix __next__() in IEnum code generator (enthought#467)
d384eeb 
(cherry picked from commit a76f0b1)
junkmd added a commit that referenced this pull request Feb 4, 2024
@junkmd @CristiFati
@jonschz @bennyrowland
Merge drop_py2 (#509)
e1d6185 
* update `appveyor.yml` (#398)

(cherry picked from commit 30f497a)

* just remove trailing whitespaces (#410)

(cherry picked from commit 7a14804)

* adjust comments (#411)

(cherry picked from commit 80ec49b)

* adjust comments (#412)

(cherry picked from commit 817b6b7)

* adjust comments (#413)

(cherry picked from commit 5b0dc8d)

* adjust comments (#414)

(cherry picked from commit a6fc08b)

* adjust comments (#415)

(cherry picked from commit 21b6ab6)

* adjust comments (#416)

(cherry picked from commit 086ec13)

* adjust comments (#417)

(cherry picked from commit 4e53792)

* adjust comments and brackets (#420)

(cherry picked from commit 14ae44d)

* unify styles for `__all__` and `__known_symbols__` (#421)

(cherry picked from commit 1398608)

* Improve error message on non Win (#423)

* Improve COM error message

* Drop Py2 stuff

* Remove dot

* Remove empty line

(cherry picked from commit 18cafb0)

* adjust styles of `client/__init__.py` (#424)

(cherry picked from commit 12d22a2)

* add auto-formatter GHA triggered by PR (#427)

* add `# fmt: ...` for avoiding redundant format

* add GHA setting

* apply automatic formatter

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
(cherry picked from commit 22bfc50)

* fix GHA settings (#431)

(cherry picked from commit 0664400)

* fix passing keyword arguments in `client.dynamic` (#432)

(cherry picked from commit 32d6621)

* remove `__cmp__` methods in `client.dynamic` (#434)

(cherry picked from commit b6a4181)

* remove `sys.version_info` bridges (#436)

(cherry picked from commit 0cadf77)

* remove `hints.AnnoField` (#437)

(cherry picked from commit 39d9e00)

* adjust import part and references (#439)

(cherry picked from commit 0fecfea)

* add tests for `client.dynamic` (#440)

(cherry picked from commit 7d69dce)

* fix `client.dynamic._Dispatch.QueryInterface` (#442)

(cherry picked from commit 6b551a4)

* add type annotations other than `Dispatch` func (#444)

(cherry picked from commit 11410ce)

* fix importing `typing` under `if TYPE_CHECKING:` (#448)

(cherry picked from commit ba1b18f)

* remove `sys.version_info` bridges (#449)

(cherry picked from commit 9238cc7)

* fix `IPersist.GetClassID` to `TYPE_CHECKING` only method from `Callable` annotation (#451)

(cherry picked from commit 446f52e)

* remove skip marks (#452)

(cherry picked from commit 6732c26)

* fix type hints to inline annotations (#453)

(cherry picked from commit 7321eaf)

* change type hints from comment annotations to inline annotations in `comtypes/__init__.py`, `comtypes/automation.py` and `comtypes/typeinfo.py` (#454)

* update `comtypes/__init__.py`

* update `comtypes/automation.py`

* update `comtypes/typeinfo.py`

* fix `Array[T]` to quoted literal strings

(cherry picked from commit 7b38a7a)

* change type hints from comment annotations to inline annotations in `_memberspec` (#455)

(cherry picked from commit 5d230aa)

* change type hints from comment annotations to inline annotations in `comtypes/client/...` (#456)

* change type hints from comment annotations to inline annotations in `comtypes/client/...`

* fix type annotations

(cherry picked from commit 18dc2cc)

* Update `codegenerator` type annotations (#457)

* update `codegenerator` type annotations

* lcid

(cherry picked from commit 9e7b900)

* Update `tlbparser` type annotations (#459)

(cherry picked from commit 0b4dbca)

* Update type annotations in `typedesc` and `typedesc_base` (#461)

* update `typedesc` type annotations

* update `typedesc_base` type annotations

(cherry picked from commit 95962e9)

* remove raising `unittest.SkipTest` from `test_getactiveobj` (#462)

(cherry picked from commit 00f2317)

* add `black` style checking to GHA settings (#465)

(cherry picked from commit 04037ae)

* modernize `test_client` (#466)

* change from udf `silence_stdout` to stdlib `contextlib.contextmanager`

* remove `sys.version_info` bridges

* remove excessive blank lines

(cherry picked from commit d470b62)

* fix `__next__()` in IEnum code generator (#467)

(cherry picked from commit a76f0b1)

* correcting type hint for CreateObject (#470)

Co-authored-by: jonschz <jonschz@users.noreply.github.com>
(cherry picked from commit 1615af5)

* Add unit test for generated IEnum (#468) (#471)

* unit test for generated IEnum (#468)

* change enum_test to a non-empty IEnum

* improved checks and clarity

* apply requested changes

Co-authored-by: jonschz <jonschz@users.noreply.github.com>
(cherry picked from commit e1ee6f0)

* make explicit the symbols that imports from the wrapper module into the friendly module (#469)

* add `Library` to generated modules' `__all__`.
because that symbol is public but not included.

* add `typelib_path` to generated modules' `__all__`.
because that symbol is public but not included.

* make `ModuleGenerator` class
that encapsulates `CodeGenerator` instance.

* rename to `generate_wrapper_code`
from `generate_code`

* add `generate_friendly_code`

* add type annotations to `generate_wrapper_code`

* add docstring

* add `get_symbols` methods
to `DeclaredNamespaces` and `ImportedNamespaces`

* update imporing symbols

* add type annotation to return value for `__init__`

* change to using f-string
in `generate_friendly_code`

(cherry picked from commit 532c399)

* remove `'Programming Language :: Python :: 2.7'` (#483)

from `setup.py`

(cherry picked from commit 9724dc0)

* change `_MemberSpec`s to `NamedTuple`s (#484)

* change `_MemberSpec` to `NamedTuple`

* `_ComMemberSpec` is no more `Generic`
for Py<3.11 backward compatibility.

* apply `black` style

(cherry picked from commit 94b81af)

* split `DISPPARAMS` instantiation in `IDispatch.Invoke` method with `__make_dp` method (#485)

(cherry picked from commit 62ce303)

* 477 Move clear_comtypes_cache to be a callable module (#478)

* move clear_comtypes_cache to be a callable module

This commit modifies the clear_comtypes_cache.py script so that it is inside
the main comtypes module (renamed as just clear_cache) so that is can be called
more easily as "py -m comtypes.clear_cache". The main function of the script is
also exported using the "console_scripts" entry point so that the script also
goes into the standard Python "Scripts" folder as before, but now as a .exe
instead of a .py script, which makes it easier to run if systems are set to
open .py files instead of running them.

This version also includes a test case using the 3rd party package pyfakefs.
Currently, this is not desired to avoid the requirement of 3rd party packages
in comtypes, but is included here for potential use if the position changes.
A subsequent commit will modify the tests to use unittest.patch instead, which
is an inferior technical solution but avoids a 3rd party package.

* modify clear_cache tests to not use pyfakefs

This commit updates the test for comtypes.clear_cache to not use any 3rd party
packages, instead relying on mocking the shutil.rmtree function which is used
to do the actual cache deletion.

* change quotes in print string

* style changes based on review by @junkmd

* Apply suggestions from code review

Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>

---------

Co-authored-by: Ben Rowland <ben.rowland@hallmarq.net>
Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>
(cherry picked from commit 8954f61)

* delint long lines (#487)

(cherry picked from commit 6532d32)

* remove `from ctypes import *` (#488)

(cherry picked from commit 65e3c10)

* remove dead optional `for_stub` arg (#489)

from `ImportedNamespaces.getvalue`

(cherry picked from commit da27aaf)

* importing the wrapper-module into the friendly-module using an abstracted name, `__wrapper_module__` (#493)

* add test

* add the `__wrapper_module__` to friendly modules

By doing so, it is possible to achieve a combination of friendly-modules
functionalities and improved access to the wrapper-modules.

(cherry picked from commit b7d5f1f)

* Fix old index bug in `call_with_inout` (#473)

* bugfix in `call_with_inout`

* minor cleanup

* handling the case of no in and no out

* Test case for _fix_inout_args

* additional cleanup and error handling

* code formatting fixed

* fix python 3.7 and 3.8 compatibility

* Temporary addition of real-world test

* code cleanup

* intermediate commit, do not review

* Refactor of unit test, removing portdevice test

* fix global side-effect of other skipped test

* Update comtypes/test/test_outparam.py

Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>

* work on tests for inout_args and outparam
- cleanup for test_outparam.py
- improvements to test_inout_args.py
- comments on a possible error in _memberspec.py

* removing dead code

* rename variables and add assertions

* pass `MagicMock` instead of `ut.TestCase`

* make tests for each argument passing patterns

* remove duplicated comments

* update test code for readability
- remove name from mock
- move line breaks to between mock preparations and assertions

* split the testcases

* add `Test_Error`

* minor corrections, remove redundancy, migration
- rewrite the permutations test
- missing direction and omitted name redundant
- migrate autogenerated keywords
- TBD: more real life tests

* Add tests covering 24 patterns
- instead of using `if` statements and `permutations`

* update test name

* add real world tests, remove old code

* formatting issue

* Update comtypes/_memberspec.py

dict type annotation

Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>

* Change missing 'in' or 'out' to be treated as 'in'

* Add real-world test: param without 'in' or 'out'

* add `contextlib.redirect_stdout`
to supress warnings

* apply review feedback

* update comments

* add line breaks to lines longer than 88 characters

* Update comtypes/test/test_inout_args.py

---------

Co-authored-by: jonschz <jonschz@users.noreply.github.com>
Co-authored-by: Jonathan <jonschz@noreply.github.com>
Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>
(cherry picked from commit 876801f)

* Fix rendering emojis in `CONTRIBUTING.md` and remove "Breaking troubles down" from "Table of contents" (#505)

(cherry picked from commit af78614)

---------

Co-authored-by: Cristi Fati <fati_utcluj@yahoo.com>
Co-authored-by: jonschz <17198703+jonschz@users.noreply.github.com>
Co-authored-by: Ben Rowland <bennyrowland@mac.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@junkmd junkmd junkmd approved these changes

Assignees
No one assigned
Labels
drop_py2 dev based on supporting only Python3, see #392
Projects
None yet
Milestone
1.3.0
Development

Successfully merging this pull request may close these issues.

Iterators in generated files implementing next() instead of __next__()
2 participants
@jonschz @junkmd