Skip to content

Commit 0b7a5a0

Browse files
committed
[pywin32] use @type_check_only and pep8 naming
1 parent d905216 commit 0b7a5a0

2 files changed

Lines changed: 101 additions & 77 deletions

File tree

stubs/pywin32/_win32typing.pyi

Lines changed: 56 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Not available at runtime. Contains type definitions that are otherwise not exposed and not part of a specific module.
22
from _typeshed import Incomplete, Unused
33
from collections.abc import Iterable, Sequence
4-
from typing import Literal, NoReturn, SupportsIndex, TypeAlias, TypedDict, final, overload
4+
from typing import Literal, NoReturn, SupportsIndex, TypeAlias, TypedDict, final, overload, type_check_only
55
from typing_extensions import Never, Required, Self, deprecated, disjoint_base
66

77
from win32.lib.pywintypes import TimeType
@@ -116,33 +116,39 @@ class DOCINFO:
116116

117117
class ExportCallback: ...
118118

119+
@type_check_only
119120
class PrinterExtents(TypedDict):
120121
Length: int
121122
Width: int
122123

124+
@type_check_only
123125
class PrinterDpi(TypedDict):
124126
xdpi: int
125127
ydpi: int
126128

129+
@type_check_only
127130
class PrinterPaperSize(TypedDict):
128131
x: int
129132
y: int
130133

131-
class SIZEL(TypedDict):
134+
@type_check_only
135+
class SizeL(TypedDict):
132136
cx: int
133137
cy: int
134138

135-
class RECTL(TypedDict):
139+
@type_check_only
140+
class RectL(TypedDict):
136141
bottom: int
137142
left: int
138143
right: int
139144
top: int
140145

141-
class FORM_INFO_1(TypedDict):
146+
@type_check_only
147+
class FormInfo1(TypedDict):
142148
Flags: int
143149
Name: str
144-
Size: SIZEL
145-
ImageableArea: RECTL
150+
Size: SizeL
151+
ImageableArea: RectL
146152

147153
class ImportCallback: ...
148154

@@ -180,20 +186,23 @@ class NCB:
180186
@property
181187
def Post(self): ...
182188

183-
class PRINTER_DEFAULTS(TypedDict, total=False):
189+
@type_check_only
190+
class PrinterDefaults(TypedDict, total=False):
184191
pDataType: str | None
185192
pDevMode: PyDEVMODEW | None
186193
DesiredAccess: Required[int]
187194

188-
class PRINTER_INFO_1(TypedDict):
195+
@type_check_only
196+
class PrinterInfo1(TypedDict):
189197
Flags: int
190198
pDescription: str
191199
pName: str
192200
pComment: str
193201

194-
PRINTER_INFO_1_TUPLE: TypeAlias = tuple[int, str, str, str]
202+
PrinterInfo1Tuple: TypeAlias = tuple[int, str, str, str]
195203

196-
class PRINTER_INFO_2(TypedDict):
204+
@type_check_only
205+
class PrinterInfo2(TypedDict):
197206
Attributes: int
198207
AveragePPM: int
199208
DefaultPriority: int
@@ -216,7 +225,7 @@ class PRINTER_INFO_2(TypedDict):
216225
pServerName: str | None
217226
pShareName: str | None
218227

219-
PRINTER_INFO_2_TUPLE: TypeAlias = tuple[
228+
PrinterInfo2Tuple: TypeAlias = tuple[
220229
str | None, # pServerName
221230
str, # pPrinterName
222231
str, # pShareName
@@ -240,32 +249,39 @@ PRINTER_INFO_2_TUPLE: TypeAlias = tuple[
240249
int, # AveragePPM
241250
]
242251

243-
class PRINTER_INFO_3(TypedDict):
252+
@type_check_only
253+
class PrinterInfo3(TypedDict):
244254
pSecurityDescriptor: PySECURITY_DESCRIPTOR
245255

246-
class PRINTER_INFO_4(TypedDict):
256+
@type_check_only
257+
class PrinterInfo4(TypedDict):
247258
Attributes: int
248259
pPrinterName: str
249260
pServerName: str | None
250261

251-
class PRINTER_INFO_5(TypedDict):
262+
@type_check_only
263+
class PrinterInfo5(TypedDict):
252264
Attributes: int
253265
DeviceNotSelectedTimeout: int
254266
TransmissionRetryTimeout: int
255267
pPortName: str
256268
pPrinterName: str
257269

258-
class PRINTER_INFO_6(TypedDict):
270+
@type_check_only
271+
class PrinterInfo6(TypedDict):
259272
Status: int
260273

261-
class PRINTER_INFO_7(TypedDict):
274+
@type_check_only
275+
class PrinterInfo7(TypedDict):
262276
Action: int
263277
ObjectGUID: str | None
264278

265-
class PRINTER_INFO_8_9(TypedDict):
279+
@type_check_only
280+
class PrinterInfo89(TypedDict):
266281
pDevMode: PyDEVMODEW | None
267282

268-
class JOB_INFO_1(TypedDict):
283+
@type_check_only
284+
class JobInfo1(TypedDict):
269285
JobId: int
270286
pPrinterName: str
271287
pMachineName: str
@@ -280,7 +296,8 @@ class JOB_INFO_1(TypedDict):
280296
PagesPrinted: int
281297
Submitted: TimeType
282298

283-
class JOB_INFO_2(JOB_INFO_1):
299+
@type_check_only
300+
class JobInfo2(JobInfo1):
284301
pNotifyName: str
285302
pPrintProcessor: str
286303
pParameters: str
@@ -292,49 +309,58 @@ class JOB_INFO_2(JOB_INFO_1):
292309
Size: int
293310
Time: int
294311

295-
class JOB_INFO_3(TypedDict):
312+
@type_check_only
313+
class JobInfo3(TypedDict):
296314
JobId: int
297315
NextJobId: int
298316
Reserved: int
299317

300-
class DRIVER_INFO_1(TypedDict):
318+
@type_check_only
319+
class DriverInfo1(TypedDict):
301320
Name: str
302321

303-
MONITOR_INFO_1: TypeAlias = DRIVER_INFO_1
304-
PORT_INFO_1: TypeAlias = DRIVER_INFO_1
322+
MonitorInfo1: TypeAlias = DriverInfo1
323+
PortInfo1: TypeAlias = DriverInfo1
305324

306-
class MONITOR_INFO_2(MONITOR_INFO_1):
325+
@type_check_only
326+
class MonitorInfo2(MonitorInfo1):
307327
DLLName: str
308328
Environment: str
309329

310-
class PORT_INFO_2(PORT_INFO_1):
330+
@type_check_only
331+
class PortInfo2(PortInfo1):
311332
Description: str
312333
MonitorName: str
313334
PortType: int
314335
Reserved: int
315336

316-
class DRIVER_INFO_2(DRIVER_INFO_1):
337+
@type_check_only
338+
class DriverInfo2(DriverInfo1):
317339
ConfigFile: str
318340
DataFile: str
319341
DriverPath: str
320342
Environment: str
321343
Version: int
322344

323-
class DRIVER_INFO_3(DRIVER_INFO_2):
345+
@type_check_only
346+
class DriverInfo3(DriverInfo2):
324347
DefaultDataType: str | None
325348
DependentFiles: list[str]
326349
HelpFile: str | None
327350
MonitorName: str | None
328351

329-
class DRIVER_INFO_4(DRIVER_INFO_3):
352+
@type_check_only
353+
class DriverInfo4(DriverInfo3):
330354
PreviousNames: str | None
331355

332-
class DRIVER_INFO_5(DRIVER_INFO_2):
356+
@type_check_only
357+
class DriverInfo5(DriverInfo2):
333358
ConfigVersion: int
334359
DriverAttributes: int
335360
DriverVersion: int
336361

337-
class DRIVER_INFO_6(DRIVER_INFO_4):
362+
@type_check_only
363+
class DriverInfo6(DriverInfo4):
338364
MfgName: str
339365
OEMUrl: str | None
340366
Provider: str

0 commit comments

Comments
 (0)