Skip to content

Commit

Permalink
Reserving blank lines in the generated modules (part 1 of #745). (#746)
Browse files Browse the repository at this point in the history 
* Split modules.

* Modify the import sections
to reflect the temporary module name change.

* Modify the `tool.ruff.lint.per-file-ignores`
to reflect the temporary module name change.

* Remove unnecessary stuff in `tools.codegenerator.comments` and `tools.generator.generator`.

* Improve import section.
  • Loading branch information
@junkmd
junkmd authored Jan 18, 2025
1 parent 4267358 commit 247aa24
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 82 deletions.
2 changes: 1 addition & 1 deletion comtypes/tools/codegenerator/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
name_friendly_module,
name_wrapper_module,
)
from comtypes.tools.codegenerator.codegenerator import CodeGenerator, version # noqa
from comtypes.tools.codegenerator.generator import CodeGenerator, version # noqa
79 changes: 79 additions & 0 deletions comtypes/tools/codegenerator/comments.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
import io

from comtypes.tools import typedesc


class ComInterfaceBodyImplCommentWriter(object):
def __init__(self, stream: io.StringIO):
self.stream = stream

def write(self, body: typedesc.ComInterfaceBody) -> None:
print(
"################################################################",
file=self.stream,
)
print(f"# code template for {body.itf.name} implementation", file=self.stream)
print(f"# class {body.itf.name}_Impl(object):", file=self.stream)

methods = {}
for m in body.itf.members:
if isinstance(m, typedesc.ComMethod):
# m.arguments is a sequence of tuples:
# (argtype, argname, idlflags, docstring)
# Some typelibs have unnamed method parameters!
inargs = [a[1] or "<unnamed>" for a in m.arguments if not "out" in a[2]]
outargs = [a[1] or "<unnamed>" for a in m.arguments if "out" in a[2]]
if "propget" in m.idlflags:
methods.setdefault(m.name, [0, inargs, outargs, m.doc])[0] |= 1
elif "propput" in m.idlflags:
methods.setdefault(m.name, [0, inargs[:-1], inargs[-1:], m.doc])[
0
] |= 2
else:
methods[m.name] = [0, inargs, outargs, m.doc]

for name, (typ, inargs, outargs, doc) in methods.items():
if typ == 0: # method
print(
f"# def {name}({', '.join(['self'] + inargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(f"# #return {', '.join(outargs)}", file=self.stream)
elif typ == 1: # propget
print("# @property", file=self.stream)
print(
f"# def {name}({', '.join(['self'] + inargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(f"# #return {', '.join(outargs)}", file=self.stream)
elif typ == 2: # propput
print(
f"# def _set({', '.join(['self'] + inargs + outargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(
f"# {name} = property(fset = _set, doc = _set.__doc__)",
file=self.stream,
)
elif typ == 3: # propget + propput
print(
f"# def _get({', '.join(['self'] + inargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(f"# #return {', '.join(outargs)}", file=self.stream)
print(
f"# def _set({', '.join(['self'] + inargs + outargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(
f"# {name} = property(_get, _set, doc = _set.__doc__)",
file=self.stream,
)
else:
raise RuntimeError("BUG")
print("#", file=self.stream)
88 changes: 8 additions & 80 deletions ...ypes/tools/codegenerator/codegenerator.py → comtypes/tools/codegenerator/generator.py
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,27 @@
# Code generator to generate code for everything contained in COM type
# libraries.
import io
import keyword
import logging
import os
import textwrap
from typing import Any
from typing import Dict, List, Tuple
from typing import Sequence
from typing import Optional, Union as _UnionT
import io
from typing import Any, Dict, List, Optional, Sequence, Tuple
from typing import Union as _UnionT

import comtypes
from comtypes import typeinfo
from comtypes.tools import tlbparser, typedesc
from comtypes.tools.codegenerator import namespaces
from comtypes.tools.codegenerator import packing
from comtypes.tools.codegenerator.modulenamer import name_wrapper_module
from comtypes.tools.codegenerator import namespaces, packing, typeannotator
from comtypes.tools.codegenerator.comments import ComInterfaceBodyImplCommentWriter
from comtypes.tools.codegenerator.helpers import (
get_real_type,
ASSUME_STRINGS,
ComMethodGenerator,
DispMethodGenerator,
DispPropertyGenerator,
TypeNamer,
get_real_type,
)
from comtypes.tools.codegenerator import typeannotator

from comtypes.tools.codegenerator.modulenamer import name_wrapper_module

version = comtypes.__version__

Expand Down Expand Up @@ -829,75 +825,7 @@ def ComInterfaceBody(self, body: typedesc.ComInterfaceBody) -> None:

print("]", file=self.stream)
print(file=self.stream)
print(
"################################################################",
file=self.stream,
)
print(f"# code template for {body.itf.name} implementation", file=self.stream)
print(f"# class {body.itf.name}_Impl(object):", file=self.stream)

methods = {}
for m in body.itf.members:
if isinstance(m, typedesc.ComMethod):
# m.arguments is a sequence of tuples:
# (argtype, argname, idlflags, docstring)
# Some typelibs have unnamed method parameters!
inargs = [a[1] or "<unnamed>" for a in m.arguments if not "out" in a[2]]
outargs = [a[1] or "<unnamed>" for a in m.arguments if "out" in a[2]]
if "propget" in m.idlflags:
methods.setdefault(m.name, [0, inargs, outargs, m.doc])[0] |= 1
elif "propput" in m.idlflags:
methods.setdefault(m.name, [0, inargs[:-1], inargs[-1:], m.doc])[
0
] |= 2
else:
methods[m.name] = [0, inargs, outargs, m.doc]

for name, (typ, inargs, outargs, doc) in methods.items():
if typ == 0: # method
print(
f"# def {name}({', '.join(['self'] + inargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(f"# #return {', '.join(outargs)}", file=self.stream)
elif typ == 1: # propget
print("# @property", file=self.stream)
print(
f"# def {name}({', '.join(['self'] + inargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(f"# #return {', '.join(outargs)}", file=self.stream)
elif typ == 2: # propput
print(
f"# def _set({', '.join(['self'] + inargs + outargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(
f"# {name} = property(fset = _set, doc = _set.__doc__)",
file=self.stream,
)
elif typ == 3: # propget + propput
print(
f"# def _get({', '.join(['self'] + inargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(f"# #return {', '.join(outargs)}", file=self.stream)
print(
f"# def _set({', '.join(['self'] + inargs + outargs)}):",
file=self.stream,
)
print(f"# {(doc or '-no docstring-')!r}", file=self.stream)
print(
f"# {name} = property(_get, _set, doc = _set.__doc__)",
file=self.stream,
)
else:
raise RuntimeError("BUG")
print("#", file=self.stream)
ComInterfaceBodyImplCommentWriter(self.stream).write(body)

def DispInterface(self, itf: typedesc.DispInterface) -> None:
self.generate(itf.get_head())
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ ignore = ["E402"]
"comtypes/server/inprocserver.py" = ["E713", "E722", "F403", "F405", "F841"]
"comtypes/server/localserver.py" = ["F401", "F403", "F405"]
"comtypes/server/register.py" = ["F403", "F405", "E713", "E731"]
"comtypes/tools/codegenerator/codegenerator.py" = ["E713", "E721"]
"comtypes/tools/codegenerator/comments.py" = ["E713", "E721"]
"comtypes/tools/codegenerator/generator.py" = ["E713", "E721"]
"comtypes/tools/codegenerator/helpers.py" = ["F401"]
"comtypes/tools/codegenerator/packing.py" = ["F821", "F841"]
"comtypes/tools/tlbparser.py" = ["F401"]
Expand Down

0 comments on commit 247aa24

Please sign in to comment.