basedpyright 1.18.3 → 1.18.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (214) hide show
  1. package/README.md +3 -3
  2. package/dist/pyright-langserver.js +1 -1
  3. package/dist/pyright-langserver.js.map +1 -1
  4. package/dist/pyright.js +1 -1
  5. package/dist/pyright.js.map +1 -1
  6. package/dist/typeshed-fallback/commit.txt +1 -1
  7. package/dist/typeshed-fallback/stdlib/VERSIONS +2 -0
  8. package/dist/typeshed-fallback/stdlib/_ast.pyi +140 -1667
  9. package/dist/typeshed-fallback/stdlib/_csv.pyi +14 -3
  10. package/dist/typeshed-fallback/stdlib/_curses.pyi +857 -65
  11. package/dist/typeshed-fallback/stdlib/_decimal.pyi +29 -820
  12. package/dist/typeshed-fallback/stdlib/_socket.pyi +4 -12
  13. package/dist/typeshed-fallback/stdlib/_sqlite3.pyi +387 -0
  14. package/dist/typeshed-fallback/stdlib/_ssl.pyi +406 -0
  15. package/dist/typeshed-fallback/stdlib/_weakref.pyi +2 -41
  16. package/dist/typeshed-fallback/stdlib/ast.pyi +1843 -172
  17. package/dist/typeshed-fallback/stdlib/builtins.pyi +5 -0
  18. package/dist/typeshed-fallback/stdlib/cProfile.pyi +3 -3
  19. package/dist/typeshed-fallback/stdlib/calendar.pyi +3 -3
  20. package/dist/typeshed-fallback/stdlib/concurrent/futures/process.pyi +3 -2
  21. package/dist/typeshed-fallback/stdlib/contextlib.pyi +6 -8
  22. package/dist/typeshed-fallback/stdlib/csv.pyi +4 -3
  23. package/dist/typeshed-fallback/stdlib/curses/__init__.pyi +7 -2
  24. package/dist/typeshed-fallback/stdlib/curses/panel.pyi +4 -4
  25. package/dist/typeshed-fallback/stdlib/curses/textpad.pyi +3 -3
  26. package/dist/typeshed-fallback/stdlib/decimal.pyi +840 -2
  27. package/dist/typeshed-fallback/stdlib/email/_policybase.pyi +27 -18
  28. package/dist/typeshed-fallback/stdlib/email/feedparser.pyi +5 -5
  29. package/dist/typeshed-fallback/stdlib/email/generator.pyi +46 -9
  30. package/dist/typeshed-fallback/stdlib/email/message.pyi +8 -6
  31. package/dist/typeshed-fallback/stdlib/email/parser.pyi +6 -4
  32. package/dist/typeshed-fallback/stdlib/email/policy.pyi +28 -10
  33. package/dist/typeshed-fallback/stdlib/http/client.pyi +3 -2
  34. package/dist/typeshed-fallback/stdlib/io.pyi +6 -22
  35. package/dist/typeshed-fallback/stdlib/multiprocessing/connection.pyi +27 -19
  36. package/dist/typeshed-fallback/stdlib/multiprocessing/context.pyi +5 -2
  37. package/dist/typeshed-fallback/stdlib/multiprocessing/managers.pyi +4 -2
  38. package/dist/typeshed-fallback/stdlib/multiprocessing/reduction.pyi +2 -2
  39. package/dist/typeshed-fallback/stdlib/profile.pyi +3 -3
  40. package/dist/typeshed-fallback/stdlib/pyexpat/__init__.pyi +1 -5
  41. package/dist/typeshed-fallback/stdlib/re.pyi +10 -1
  42. package/dist/typeshed-fallback/stdlib/socket.pyi +12 -4
  43. package/dist/typeshed-fallback/stdlib/sqlite3/__init__.pyi +739 -1
  44. package/dist/typeshed-fallback/stdlib/sqlite3/dbapi2.pyi +220 -884
  45. package/dist/typeshed-fallback/stdlib/sre_constants.pyi +1 -8
  46. package/dist/typeshed-fallback/stdlib/ssl.pyi +40 -128
  47. package/dist/typeshed-fallback/stdlib/tarfile.pyi +111 -6
  48. package/dist/typeshed-fallback/stdlib/tkinter/__init__.pyi +127 -21
  49. package/dist/typeshed-fallback/stdlib/tokenize.pyi +1 -1
  50. package/dist/typeshed-fallback/stdlib/typing.pyi +7 -7
  51. package/dist/typeshed-fallback/stdlib/typing_extensions.pyi +1 -1
  52. package/dist/typeshed-fallback/stdlib/unittest/mock.pyi +2 -2
  53. package/dist/typeshed-fallback/stdlib/weakref.pyi +49 -14
  54. package/dist/typeshed-fallback/stdlib/xml/parsers/expat/__init__.pyi +6 -0
  55. package/dist/typeshed-fallback/stdlib/xmlrpc/client.pyi +1 -1
  56. package/dist/typeshed-fallback/stdlib/xmlrpc/server.pyi +3 -2
  57. package/dist/typeshed-fallback/stdlib/zoneinfo/__init__.pyi +41 -44
  58. package/dist/typeshed-fallback/stdlib/zoneinfo/_common.pyi +13 -0
  59. package/dist/typeshed-fallback/stdlib/zoneinfo/_tzpath.pyi +13 -0
  60. package/dist/typeshed-fallback/stubs/Flask-SocketIO/METADATA.toml +1 -1
  61. package/dist/typeshed-fallback/stubs/braintree/METADATA.toml +1 -1
  62. package/dist/typeshed-fallback/stubs/braintree/braintree/error_codes.pyi +1 -0
  63. package/dist/typeshed-fallback/stubs/docutils/docutils/__init__.pyi +3 -1
  64. package/dist/typeshed-fallback/stubs/docutils/docutils/frontend.pyi +1 -2
  65. package/dist/typeshed-fallback/stubs/docutils/docutils/parsers/rst/directives/admonitions.pyi +15 -2
  66. package/dist/typeshed-fallback/stubs/docutils/docutils/readers/doctree.pyi +1 -1
  67. package/dist/typeshed-fallback/stubs/docutils/docutils/writers/__init__.pyi +21 -2
  68. package/dist/typeshed-fallback/stubs/fpdf2/fpdf/fpdf.pyi +4 -4
  69. package/dist/typeshed-fallback/stubs/greenlet/METADATA.toml +1 -1
  70. package/dist/typeshed-fallback/stubs/hdbcli/METADATA.toml +1 -1
  71. package/dist/typeshed-fallback/stubs/icalendar/METADATA.toml +5 -2
  72. package/dist/typeshed-fallback/stubs/icalendar/icalendar/__init__.pyi +49 -5
  73. package/dist/typeshed-fallback/stubs/icalendar/icalendar/cal.pyi +32 -6
  74. package/dist/typeshed-fallback/stubs/icalendar/icalendar/caselessdict.pyi +2 -0
  75. package/dist/typeshed-fallback/stubs/icalendar/icalendar/parser.pyi +25 -1
  76. package/dist/typeshed-fallback/stubs/icalendar/icalendar/parser_tools.pyi +7 -3
  77. package/dist/typeshed-fallback/stubs/icalendar/icalendar/prop.pyi +112 -72
  78. package/dist/typeshed-fallback/stubs/icalendar/icalendar/timezone/__init__.pyi +8 -0
  79. package/dist/typeshed-fallback/stubs/icalendar/icalendar/timezone/provider.pyi +29 -0
  80. package/dist/typeshed-fallback/stubs/icalendar/icalendar/timezone/pytz.pyi +22 -0
  81. package/dist/typeshed-fallback/stubs/icalendar/icalendar/timezone/tzp.pyi +30 -0
  82. package/dist/typeshed-fallback/stubs/icalendar/icalendar/timezone/zoneinfo.pyi +33 -0
  83. package/dist/typeshed-fallback/stubs/icalendar/icalendar/tools.pyi +2 -0
  84. package/dist/typeshed-fallback/stubs/icalendar/icalendar/version.pyi +8 -0
  85. package/dist/typeshed-fallback/stubs/jwcrypto/METADATA.toml +3 -0
  86. package/dist/typeshed-fallback/stubs/jwcrypto/jwcrypto/common.pyi +48 -0
  87. package/dist/typeshed-fallback/stubs/jwcrypto/jwcrypto/jwa.pyi +35 -0
  88. package/dist/typeshed-fallback/stubs/jwcrypto/jwcrypto/jwe.pyi +51 -0
  89. package/dist/typeshed-fallback/stubs/jwcrypto/jwcrypto/jwk.pyi +115 -0
  90. package/dist/typeshed-fallback/stubs/jwcrypto/jwcrypto/jws.pyi +52 -0
  91. package/dist/typeshed-fallback/stubs/jwcrypto/jwcrypto/jwt.pyi +78 -0
  92. package/dist/typeshed-fallback/stubs/m3u8/METADATA.toml +2 -0
  93. package/dist/typeshed-fallback/stubs/m3u8/m3u8/__init__.pyi +74 -0
  94. package/dist/typeshed-fallback/stubs/m3u8/m3u8/httpclient.pyi +19 -0
  95. package/dist/typeshed-fallback/stubs/m3u8/m3u8/mixins.pyi +25 -0
  96. package/dist/typeshed-fallback/stubs/m3u8/m3u8/model.pyi +406 -0
  97. package/dist/typeshed-fallback/stubs/m3u8/m3u8/parser.pyi +14 -0
  98. package/dist/typeshed-fallback/stubs/m3u8/m3u8/protocol.pyi +41 -0
  99. package/dist/typeshed-fallback/stubs/m3u8/m3u8/version_matching.pyi +5 -0
  100. package/dist/typeshed-fallback/stubs/m3u8/m3u8/version_matching_rules.pyi +24 -0
  101. package/dist/typeshed-fallback/stubs/paramiko/paramiko/transport.pyi +2 -1
  102. package/dist/typeshed-fallback/stubs/protobuf/METADATA.toml +2 -2
  103. package/dist/typeshed-fallback/stubs/protobuf/google/protobuf/descriptor_pb2.pyi +4 -3
  104. package/dist/typeshed-fallback/stubs/protobuf/google/protobuf/internal/well_known_types.pyi +0 -1
  105. package/dist/typeshed-fallback/stubs/pytz/pytz/__init__.pyi +4 -4
  106. package/dist/typeshed-fallback/stubs/pytz/pytz/tzinfo.pyi +1 -1
  107. package/dist/typeshed-fallback/stubs/qrcode/METADATA.toml +3 -2
  108. package/dist/typeshed-fallback/stubs/redis/redis/client.pyi +18 -0
  109. package/dist/typeshed-fallback/stubs/reportlab/METADATA.toml +1 -1
  110. package/dist/typeshed-fallback/stubs/reportlab/reportlab/graphics/renderPDF.pyi +2 -2
  111. package/dist/typeshed-fallback/stubs/seaborn/METADATA.toml +9 -1
  112. package/dist/typeshed-fallback/stubs/vobject/vobject/__init__.pyi +4 -0
  113. package/dist/typeshed-fallback/stubs/vobject/vobject/base.pyi +11 -2
  114. package/dist/typeshed-fallback/stubs/vobject/vobject/behavior.pyi +1 -1
  115. package/dist/typeshed-fallback/stubs/vobject/vobject/change_tz.pyi +4 -0
  116. package/dist/typeshed-fallback/stubs/vobject/vobject/ics_diff.pyi +0 -3
  117. package/dist/typeshed-fallback/stubs/vobject/vobject/vcard.pyi +1 -1
  118. package/dist/typeshed-fallback/stubs/waitress/waitress/__init__.pyi +2 -2
  119. package/package.json +1 -1
  120. package/dist/typeshed-fallback/stubs/Pillow/METADATA.toml +0 -8
  121. package/dist/typeshed-fallback/stubs/Pillow/PIL/BdfFontFile.pyi +0 -11
  122. package/dist/typeshed-fallback/stubs/Pillow/PIL/BlpImagePlugin.pyi +0 -39
  123. package/dist/typeshed-fallback/stubs/Pillow/PIL/BmpImagePlugin.pyi +0 -25
  124. package/dist/typeshed-fallback/stubs/Pillow/PIL/BufrStubImagePlugin.pyi +0 -9
  125. package/dist/typeshed-fallback/stubs/Pillow/PIL/ContainerIO.pyi +0 -14
  126. package/dist/typeshed-fallback/stubs/Pillow/PIL/CurImagePlugin.pyi +0 -6
  127. package/dist/typeshed-fallback/stubs/Pillow/PIL/DcxImagePlugin.pyi +0 -13
  128. package/dist/typeshed-fallback/stubs/Pillow/PIL/DdsImagePlugin.pyi +0 -314
  129. package/dist/typeshed-fallback/stubs/Pillow/PIL/EpsImagePlugin.pyi +0 -34
  130. package/dist/typeshed-fallback/stubs/Pillow/PIL/ExifTags.pyi +0 -347
  131. package/dist/typeshed-fallback/stubs/Pillow/PIL/FitsImagePlugin.pyi +0 -7
  132. package/dist/typeshed-fallback/stubs/Pillow/PIL/FliImagePlugin.pyi +0 -9
  133. package/dist/typeshed-fallback/stubs/Pillow/PIL/FontFile.pyi +0 -16
  134. package/dist/typeshed-fallback/stubs/Pillow/PIL/FpxImagePlugin.pyi +0 -23
  135. package/dist/typeshed-fallback/stubs/Pillow/PIL/FtexImagePlugin.pyi +0 -15
  136. package/dist/typeshed-fallback/stubs/Pillow/PIL/GbrImagePlugin.pyi +0 -11
  137. package/dist/typeshed-fallback/stubs/Pillow/PIL/GdImageFile.pyi +0 -9
  138. package/dist/typeshed-fallback/stubs/Pillow/PIL/GifImagePlugin.pyi +0 -31
  139. package/dist/typeshed-fallback/stubs/Pillow/PIL/GimpGradientFile.pyi +0 -19
  140. package/dist/typeshed-fallback/stubs/Pillow/PIL/GimpPaletteFile.pyi +0 -7
  141. package/dist/typeshed-fallback/stubs/Pillow/PIL/GribStubImagePlugin.pyi +0 -9
  142. package/dist/typeshed-fallback/stubs/Pillow/PIL/Hdf5StubImagePlugin.pyi +0 -9
  143. package/dist/typeshed-fallback/stubs/Pillow/PIL/IcnsImagePlugin.pyi +0 -36
  144. package/dist/typeshed-fallback/stubs/Pillow/PIL/IcoImagePlugin.pyi +0 -26
  145. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImImagePlugin.pyi +0 -34
  146. package/dist/typeshed-fallback/stubs/Pillow/PIL/Image.pyi +0 -342
  147. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageChops.pyi +0 -23
  148. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageCms.pyi +0 -84
  149. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageColor.pyi +0 -10
  150. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageDraw.pyi +0 -155
  151. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageDraw2.pyi +0 -37
  152. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageEnhance.pyi +0 -25
  153. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageFile.pyi +0 -89
  154. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageFilter.pyi +0 -136
  155. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageFont.pyi +0 -114
  156. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageGrab.pyi +0 -36
  157. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageMath.pyi +0 -49
  158. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageMode.pyi +0 -10
  159. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageMorph.pyi +0 -26
  160. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageOps.pyi +0 -53
  161. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImagePalette.pyi +0 -26
  162. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImagePath.pyi +0 -3
  163. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageQt.pyi +0 -26
  164. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageSequence.pyi +0 -14
  165. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageShow.pyi +0 -58
  166. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageStat.pyi +0 -14
  167. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageTk.pyi +0 -51
  168. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageTransform.pyi +0 -21
  169. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImageWin.pyi +0 -38
  170. package/dist/typeshed-fallback/stubs/Pillow/PIL/ImtImagePlugin.pyi +0 -10
  171. package/dist/typeshed-fallback/stubs/Pillow/PIL/IptcImagePlugin.pyi +0 -23
  172. package/dist/typeshed-fallback/stubs/Pillow/PIL/Jpeg2KImagePlugin.pyi +0 -23
  173. package/dist/typeshed-fallback/stubs/Pillow/PIL/JpegImagePlugin.pyi +0 -30
  174. package/dist/typeshed-fallback/stubs/Pillow/PIL/JpegPresets.pyi +0 -3
  175. package/dist/typeshed-fallback/stubs/Pillow/PIL/McIdasImagePlugin.pyi +0 -7
  176. package/dist/typeshed-fallback/stubs/Pillow/PIL/MicImagePlugin.pyi +0 -18
  177. package/dist/typeshed-fallback/stubs/Pillow/PIL/MpegImagePlugin.pyi +0 -18
  178. package/dist/typeshed-fallback/stubs/Pillow/PIL/MpoImagePlugin.pyi +0 -15
  179. package/dist/typeshed-fallback/stubs/Pillow/PIL/MspImagePlugin.pyi +0 -10
  180. package/dist/typeshed-fallback/stubs/Pillow/PIL/PSDraw.pyi +0 -19
  181. package/dist/typeshed-fallback/stubs/Pillow/PIL/PaletteFile.pyi +0 -7
  182. package/dist/typeshed-fallback/stubs/Pillow/PIL/PalmImagePlugin.pyi +0 -5
  183. package/dist/typeshed-fallback/stubs/Pillow/PIL/PcdImagePlugin.pyi +0 -10
  184. package/dist/typeshed-fallback/stubs/Pillow/PIL/PcfFontFile.pyi +0 -25
  185. package/dist/typeshed-fallback/stubs/Pillow/PIL/PcxImagePlugin.pyi +0 -10
  186. package/dist/typeshed-fallback/stubs/Pillow/PIL/PdfParser.pyi +0 -167
  187. package/dist/typeshed-fallback/stubs/Pillow/PIL/PixarImagePlugin.pyi +0 -7
  188. package/dist/typeshed-fallback/stubs/Pillow/PIL/PngImagePlugin.pyi +0 -115
  189. package/dist/typeshed-fallback/stubs/Pillow/PIL/PpmImagePlugin.pyi +0 -17
  190. package/dist/typeshed-fallback/stubs/Pillow/PIL/PsdImagePlugin.pyi +0 -17
  191. package/dist/typeshed-fallback/stubs/Pillow/PIL/PyAccess.pyi +0 -69
  192. package/dist/typeshed-fallback/stubs/Pillow/PIL/QoiImagePlugin.pyi +0 -11
  193. package/dist/typeshed-fallback/stubs/Pillow/PIL/SgiImagePlugin.pyi +0 -13
  194. package/dist/typeshed-fallback/stubs/Pillow/PIL/SpiderImagePlugin.pyi +0 -28
  195. package/dist/typeshed-fallback/stubs/Pillow/PIL/SunImagePlugin.pyi +0 -7
  196. package/dist/typeshed-fallback/stubs/Pillow/PIL/TarIO.pyi +0 -12
  197. package/dist/typeshed-fallback/stubs/Pillow/PIL/TgaImagePlugin.pyi +0 -12
  198. package/dist/typeshed-fallback/stubs/Pillow/PIL/TiffImagePlugin.pyi +0 -295
  199. package/dist/typeshed-fallback/stubs/Pillow/PIL/TiffTags.pyi +0 -46
  200. package/dist/typeshed-fallback/stubs/Pillow/PIL/WalImageFile.pyi +0 -14
  201. package/dist/typeshed-fallback/stubs/Pillow/PIL/WebPImagePlugin.pyi +0 -18
  202. package/dist/typeshed-fallback/stubs/Pillow/PIL/WmfImagePlugin.pyi +0 -19
  203. package/dist/typeshed-fallback/stubs/Pillow/PIL/XVThumbImagePlugin.pyi +0 -9
  204. package/dist/typeshed-fallback/stubs/Pillow/PIL/XbmImagePlugin.pyi +0 -10
  205. package/dist/typeshed-fallback/stubs/Pillow/PIL/XpmImagePlugin.pyi +0 -11
  206. package/dist/typeshed-fallback/stubs/Pillow/PIL/__init__.pyi +0 -3
  207. package/dist/typeshed-fallback/stubs/Pillow/PIL/_binary.pyi +0 -13
  208. package/dist/typeshed-fallback/stubs/Pillow/PIL/_imaging.pyi +0 -29
  209. package/dist/typeshed-fallback/stubs/Pillow/PIL/_tkinter_finder.pyi +0 -2
  210. package/dist/typeshed-fallback/stubs/Pillow/PIL/_version.pyi +0 -1
  211. package/dist/typeshed-fallback/stubs/Pillow/PIL/features.pyi +0 -23
  212. package/dist/typeshed-fallback/stubs/icalendar/icalendar/timezone_cache.pyi +0 -0
  213. /package/dist/typeshed-fallback/stubs/icalendar/icalendar/{windows_to_olson.pyi → timezone/windows_to_olson.pyi} +0 -0
  214. /package/dist/typeshed-fallback/stubs/{Pillow/PIL/PdfImagePlugin.pyi → jwcrypto/jwcrypto/__init__.pyi} +0 -0
@@ -428,7 +428,7 @@ def getsyx() -> tuple[int, int]:
428
428
  Return a (y, x) tuple. If leaveok is currently true, return (-1, -1).
429
429
  """
430
430
  ...
431
- def getwin(file: SupportsRead[bytes], /) -> _CursesWindow:
431
+ def getwin(file: SupportsRead[bytes], /) -> window:
432
432
  """
433
433
  Read window related data stored in the file by an earlier putwin() call.
434
434
 
@@ -507,7 +507,7 @@ def init_pair(pair_number: int, fg: int, bg: int, /) -> None:
507
507
  all occurrences of that color-pair are changed to the new definition.
508
508
  """
509
509
  ...
510
- def initscr() -> _CursesWindow:
510
+ def initscr() -> window:
511
511
  """
512
512
  Initialize the library.
513
513
 
@@ -585,7 +585,7 @@ def napms(ms: int, /) -> int:
585
585
  Duration in milliseconds.
586
586
  """
587
587
  ...
588
- def newpad(nlines: int, ncols: int, /) -> _CursesWindow:
588
+ def newpad(nlines: int, ncols: int, /) -> window:
589
589
  """
590
590
  Create and return a pointer to a new pad data structure.
591
591
 
@@ -595,7 +595,7 @@ def newpad(nlines: int, ncols: int, /) -> _CursesWindow:
595
595
  Width.
596
596
  """
597
597
  ...
598
- def newwin(nlines: int, ncols: int, begin_y: int = ..., begin_x: int = ..., /) -> _CursesWindow:
598
+ def newwin(nlines: int, ncols: int, begin_y: int = ..., begin_x: int = ..., /) -> window:
599
599
  """
600
600
  newwin(nlines, ncols, [begin_y=0, begin_x=0])
601
601
  Return a new window.
@@ -926,25 +926,167 @@ def use_env(flag: bool, /) -> None:
926
926
  class error(Exception): ...
927
927
 
928
928
  @final
929
- class _CursesWindow:
929
+ class window: # undocumented
930
930
  encoding: str
931
931
  @overload
932
- def addch(self, ch: _ChType, attr: int = ...) -> None: ...
932
+ def addch(self, ch: _ChType, attr: int = ...) -> None:
933
+ """
934
+ addch([y, x,] ch, [attr=_curses.A_NORMAL])
935
+ Paint the character.
936
+
937
+ y
938
+ Y-coordinate.
939
+ x
940
+ X-coordinate.
941
+ ch
942
+ Character to add.
943
+ attr
944
+ Attributes for the character.
945
+
946
+ Paint character ch at (y, x) with attributes attr,
947
+ overwriting any character previously painted at that location.
948
+ By default, the character position and attributes are the
949
+ current settings for the window object.
950
+ """
951
+ ...
933
952
  @overload
934
- def addch(self, y: int, x: int, ch: _ChType, attr: int = ...) -> None: ...
953
+ def addch(self, y: int, x: int, ch: _ChType, attr: int = ...) -> None:
954
+ """
955
+ addch([y, x,] ch, [attr=_curses.A_NORMAL])
956
+ Paint the character.
957
+
958
+ y
959
+ Y-coordinate.
960
+ x
961
+ X-coordinate.
962
+ ch
963
+ Character to add.
964
+ attr
965
+ Attributes for the character.
966
+
967
+ Paint character ch at (y, x) with attributes attr,
968
+ overwriting any character previously painted at that location.
969
+ By default, the character position and attributes are the
970
+ current settings for the window object.
971
+ """
972
+ ...
935
973
  @overload
936
- def addnstr(self, str: str, n: int, attr: int = ...) -> None: ...
974
+ def addnstr(self, str: str, n: int, attr: int = ...) -> None:
975
+ """
976
+ addnstr([y, x,] str, n, [attr])
977
+ Paint at most n characters of the string.
978
+
979
+ y
980
+ Y-coordinate.
981
+ x
982
+ X-coordinate.
983
+ str
984
+ String to add.
985
+ n
986
+ Maximal number of characters.
987
+ attr
988
+ Attributes for characters.
989
+
990
+ Paint at most n characters of the string str at (y, x) with
991
+ attributes attr, overwriting anything previously on the display.
992
+ By default, the character position and attributes are the
993
+ current settings for the window object.
994
+ """
995
+ ...
937
996
  @overload
938
- def addnstr(self, y: int, x: int, str: str, n: int, attr: int = ...) -> None: ...
997
+ def addnstr(self, y: int, x: int, str: str, n: int, attr: int = ...) -> None:
998
+ """
999
+ addnstr([y, x,] str, n, [attr])
1000
+ Paint at most n characters of the string.
1001
+
1002
+ y
1003
+ Y-coordinate.
1004
+ x
1005
+ X-coordinate.
1006
+ str
1007
+ String to add.
1008
+ n
1009
+ Maximal number of characters.
1010
+ attr
1011
+ Attributes for characters.
1012
+
1013
+ Paint at most n characters of the string str at (y, x) with
1014
+ attributes attr, overwriting anything previously on the display.
1015
+ By default, the character position and attributes are the
1016
+ current settings for the window object.
1017
+ """
1018
+ ...
939
1019
  @overload
940
- def addstr(self, str: str, attr: int = ...) -> None: ...
1020
+ def addstr(self, str: str, attr: int = ...) -> None:
1021
+ """
1022
+ addstr([y, x,] str, [attr])
1023
+ Paint the string.
1024
+
1025
+ y
1026
+ Y-coordinate.
1027
+ x
1028
+ X-coordinate.
1029
+ str
1030
+ String to add.
1031
+ attr
1032
+ Attributes for characters.
1033
+
1034
+ Paint the string str at (y, x) with attributes attr,
1035
+ overwriting anything previously on the display.
1036
+ By default, the character position and attributes are the
1037
+ current settings for the window object.
1038
+ """
1039
+ ...
941
1040
  @overload
942
- def addstr(self, y: int, x: int, str: str, attr: int = ...) -> None: ...
943
- def attroff(self, attr: int, /) -> None: ...
944
- def attron(self, attr: int, /) -> None: ...
945
- def attrset(self, attr: int, /) -> None: ...
946
- def bkgd(self, ch: _ChType, attr: int = ..., /) -> None: ...
947
- def bkgdset(self, ch: _ChType, attr: int = ..., /) -> None: ...
1041
+ def addstr(self, y: int, x: int, str: str, attr: int = ...) -> None:
1042
+ """
1043
+ addstr([y, x,] str, [attr])
1044
+ Paint the string.
1045
+
1046
+ y
1047
+ Y-coordinate.
1048
+ x
1049
+ X-coordinate.
1050
+ str
1051
+ String to add.
1052
+ attr
1053
+ Attributes for characters.
1054
+
1055
+ Paint the string str at (y, x) with attributes attr,
1056
+ overwriting anything previously on the display.
1057
+ By default, the character position and attributes are the
1058
+ current settings for the window object.
1059
+ """
1060
+ ...
1061
+ def attroff(self, attr: int, /) -> None:
1062
+ """Remove attribute attr from the "background" set."""
1063
+ ...
1064
+ def attron(self, attr: int, /) -> None:
1065
+ """Add attribute attr from the "background" set."""
1066
+ ...
1067
+ def attrset(self, attr: int, /) -> None:
1068
+ """Set the "background" set of attributes."""
1069
+ ...
1070
+ def bkgd(self, ch: _ChType, attr: int = ..., /) -> None:
1071
+ """
1072
+ Set the background property of the window.
1073
+
1074
+ ch
1075
+ Background character.
1076
+ attr
1077
+ Background attributes.
1078
+ """
1079
+ ...
1080
+ def bkgdset(self, ch: _ChType, attr: int = ..., /) -> None:
1081
+ """
1082
+ Set the window's background.
1083
+
1084
+ ch
1085
+ Background character.
1086
+ attr
1087
+ Background attributes.
1088
+ """
1089
+ ...
948
1090
  def border(
949
1091
  self,
950
1092
  ls: _ChType = ...,
@@ -955,11 +1097,63 @@ class _CursesWindow:
955
1097
  tr: _ChType = ...,
956
1098
  bl: _ChType = ...,
957
1099
  br: _ChType = ...,
958
- ) -> None: ...
1100
+ ) -> None:
1101
+ """
1102
+ Draw a border around the edges of the window.
1103
+
1104
+ ls
1105
+ Left side.
1106
+ rs
1107
+ Right side.
1108
+ ts
1109
+ Top side.
1110
+ bs
1111
+ Bottom side.
1112
+ tl
1113
+ Upper-left corner.
1114
+ tr
1115
+ Upper-right corner.
1116
+ bl
1117
+ Bottom-left corner.
1118
+ br
1119
+ Bottom-right corner.
1120
+
1121
+ Each parameter specifies the character to use for a specific part of the
1122
+ border. The characters can be specified as integers or as one-character
1123
+ strings. A 0 value for any parameter will cause the default character to be
1124
+ used for that parameter.
1125
+ """
1126
+ ...
959
1127
  @overload
960
- def box(self) -> None: ...
1128
+ def box(self) -> None:
1129
+ """
1130
+ box([verch=0, horch=0])
1131
+ Draw a border around the edges of the window.
1132
+
1133
+ verch
1134
+ Left and right side.
1135
+ horch
1136
+ Top and bottom side.
1137
+
1138
+ Similar to border(), but both ls and rs are verch and both ts and bs are
1139
+ horch. The default corner characters are always used by this function.
1140
+ """
1141
+ ...
961
1142
  @overload
962
- def box(self, vertch: _ChType = ..., horch: _ChType = ...) -> None: ...
1143
+ def box(self, vertch: _ChType = ..., horch: _ChType = ...) -> None:
1144
+ """
1145
+ box([verch=0, horch=0])
1146
+ Draw a border around the edges of the window.
1147
+
1148
+ verch
1149
+ Left and right side.
1150
+ horch
1151
+ Top and bottom side.
1152
+
1153
+ Similar to border(), but both ls and rs are verch and both ts and bs are
1154
+ horch. The default corner characters are always used by this function.
1155
+ """
1156
+ ...
963
1157
  @overload
964
1158
  def chgat(self, attr: int) -> None: ...
965
1159
  @overload
@@ -974,31 +1168,189 @@ class _CursesWindow:
974
1168
  def clrtoeol(self) -> None: ...
975
1169
  def cursyncup(self) -> None: ...
976
1170
  @overload
977
- def delch(self) -> None: ...
1171
+ def delch(self) -> None:
1172
+ """
1173
+ delch([y, x])
1174
+ Delete any character at (y, x).
1175
+
1176
+ y
1177
+ Y-coordinate.
1178
+ x
1179
+ X-coordinate.
1180
+ """
1181
+ ...
978
1182
  @overload
979
- def delch(self, y: int, x: int) -> None: ...
1183
+ def delch(self, y: int, x: int) -> None:
1184
+ """
1185
+ delch([y, x])
1186
+ Delete any character at (y, x).
1187
+
1188
+ y
1189
+ Y-coordinate.
1190
+ x
1191
+ X-coordinate.
1192
+ """
1193
+ ...
980
1194
  def deleteln(self) -> None: ...
981
1195
  @overload
982
- def derwin(self, begin_y: int, begin_x: int) -> _CursesWindow: ...
1196
+ def derwin(self, begin_y: int, begin_x: int) -> window:
1197
+ """
1198
+ derwin([nlines=0, ncols=0,] begin_y, begin_x)
1199
+ Create a sub-window (window-relative coordinates).
1200
+
1201
+ nlines
1202
+ Height.
1203
+ ncols
1204
+ Width.
1205
+ begin_y
1206
+ Top side y-coordinate.
1207
+ begin_x
1208
+ Left side x-coordinate.
1209
+
1210
+ derwin() is the same as calling subwin(), except that begin_y and begin_x
1211
+ are relative to the origin of the window, rather than relative to the entire
1212
+ screen.
1213
+ """
1214
+ ...
983
1215
  @overload
984
- def derwin(self, nlines: int, ncols: int, begin_y: int, begin_x: int) -> _CursesWindow: ...
985
- def echochar(self, ch: _ChType, attr: int = ..., /) -> None: ...
986
- def enclose(self, y: int, x: int, /) -> bool: ...
1216
+ def derwin(self, nlines: int, ncols: int, begin_y: int, begin_x: int) -> window:
1217
+ """
1218
+ derwin([nlines=0, ncols=0,] begin_y, begin_x)
1219
+ Create a sub-window (window-relative coordinates).
1220
+
1221
+ nlines
1222
+ Height.
1223
+ ncols
1224
+ Width.
1225
+ begin_y
1226
+ Top side y-coordinate.
1227
+ begin_x
1228
+ Left side x-coordinate.
1229
+
1230
+ derwin() is the same as calling subwin(), except that begin_y and begin_x
1231
+ are relative to the origin of the window, rather than relative to the entire
1232
+ screen.
1233
+ """
1234
+ ...
1235
+ def echochar(self, ch: _ChType, attr: int = ..., /) -> None:
1236
+ """
1237
+ Add character ch with attribute attr, and refresh.
1238
+
1239
+ ch
1240
+ Character to add.
1241
+ attr
1242
+ Attributes for the character.
1243
+ """
1244
+ ...
1245
+ def enclose(self, y: int, x: int, /) -> bool:
1246
+ """
1247
+ Return True if the screen-relative coordinates are enclosed by the window.
1248
+
1249
+ y
1250
+ Y-coordinate.
1251
+ x
1252
+ X-coordinate.
1253
+ """
1254
+ ...
987
1255
  def erase(self) -> None: ...
988
1256
  def getbegyx(self) -> tuple[int, int]: ...
989
- def getbkgd(self) -> tuple[int, int]: ...
1257
+ def getbkgd(self) -> tuple[int, int]:
1258
+ """Return the window's current background character/attribute pair."""
1259
+ ...
990
1260
  @overload
991
- def getch(self) -> int: ...
1261
+ def getch(self) -> int:
1262
+ """
1263
+ getch([y, x])
1264
+ Get a character code from terminal keyboard.
1265
+
1266
+ y
1267
+ Y-coordinate.
1268
+ x
1269
+ X-coordinate.
1270
+
1271
+ The integer returned does not have to be in ASCII range: function keys,
1272
+ keypad keys and so on return numbers higher than 256. In no-delay mode, -1
1273
+ is returned if there is no input, else getch() waits until a key is pressed.
1274
+ """
1275
+ ...
992
1276
  @overload
993
- def getch(self, y: int, x: int) -> int: ...
1277
+ def getch(self, y: int, x: int) -> int:
1278
+ """
1279
+ getch([y, x])
1280
+ Get a character code from terminal keyboard.
1281
+
1282
+ y
1283
+ Y-coordinate.
1284
+ x
1285
+ X-coordinate.
1286
+
1287
+ The integer returned does not have to be in ASCII range: function keys,
1288
+ keypad keys and so on return numbers higher than 256. In no-delay mode, -1
1289
+ is returned if there is no input, else getch() waits until a key is pressed.
1290
+ """
1291
+ ...
994
1292
  @overload
995
- def get_wch(self) -> int | str: ...
1293
+ def get_wch(self) -> int | str:
1294
+ """
1295
+ get_wch([y, x])
1296
+ Get a wide character from terminal keyboard.
1297
+
1298
+ y
1299
+ Y-coordinate.
1300
+ x
1301
+ X-coordinate.
1302
+
1303
+ Return a character for most keys, or an integer for function keys,
1304
+ keypad keys, and other special keys.
1305
+ """
1306
+ ...
996
1307
  @overload
997
- def get_wch(self, y: int, x: int) -> int | str: ...
1308
+ def get_wch(self, y: int, x: int) -> int | str:
1309
+ """
1310
+ get_wch([y, x])
1311
+ Get a wide character from terminal keyboard.
1312
+
1313
+ y
1314
+ Y-coordinate.
1315
+ x
1316
+ X-coordinate.
1317
+
1318
+ Return a character for most keys, or an integer for function keys,
1319
+ keypad keys, and other special keys.
1320
+ """
1321
+ ...
998
1322
  @overload
999
- def getkey(self) -> str: ...
1323
+ def getkey(self) -> str:
1324
+ """
1325
+ getkey([y, x])
1326
+ Get a character (string) from terminal keyboard.
1327
+
1328
+ y
1329
+ Y-coordinate.
1330
+ x
1331
+ X-coordinate.
1332
+
1333
+ Returning a string instead of an integer, as getch() does. Function keys,
1334
+ keypad keys and other special keys return a multibyte string containing the
1335
+ key name. In no-delay mode, an exception is raised if there is no input.
1336
+ """
1337
+ ...
1000
1338
  @overload
1001
- def getkey(self, y: int, x: int) -> str: ...
1339
+ def getkey(self, y: int, x: int) -> str:
1340
+ """
1341
+ getkey([y, x])
1342
+ Get a character (string) from terminal keyboard.
1343
+
1344
+ y
1345
+ Y-coordinate.
1346
+ x
1347
+ X-coordinate.
1348
+
1349
+ Returning a string instead of an integer, as getch() does. Function keys,
1350
+ keypad keys and other special keys return a multibyte string containing the
1351
+ key name. In no-delay mode, an exception is raised if there is no input.
1352
+ """
1353
+ ...
1002
1354
  def getmaxyx(self) -> tuple[int, int]: ...
1003
1355
  def getparyx(self) -> tuple[int, int]: ...
1004
1356
  @overload
@@ -1011,35 +1363,220 @@ class _CursesWindow:
1011
1363
  def getstr(self, y: int, x: int, n: int) -> bytes: ...
1012
1364
  def getyx(self) -> tuple[int, int]: ...
1013
1365
  @overload
1014
- def hline(self, ch: _ChType, n: int) -> None: ...
1366
+ def hline(self, ch: _ChType, n: int) -> None:
1367
+ """
1368
+ hline([y, x,] ch, n, [attr=_curses.A_NORMAL])
1369
+ Display a horizontal line.
1370
+
1371
+ y
1372
+ Starting Y-coordinate.
1373
+ x
1374
+ Starting X-coordinate.
1375
+ ch
1376
+ Character to draw.
1377
+ n
1378
+ Line length.
1379
+ attr
1380
+ Attributes for the characters.
1381
+ """
1382
+ ...
1015
1383
  @overload
1016
- def hline(self, y: int, x: int, ch: _ChType, n: int) -> None: ...
1384
+ def hline(self, y: int, x: int, ch: _ChType, n: int) -> None:
1385
+ """
1386
+ hline([y, x,] ch, n, [attr=_curses.A_NORMAL])
1387
+ Display a horizontal line.
1388
+
1389
+ y
1390
+ Starting Y-coordinate.
1391
+ x
1392
+ Starting X-coordinate.
1393
+ ch
1394
+ Character to draw.
1395
+ n
1396
+ Line length.
1397
+ attr
1398
+ Attributes for the characters.
1399
+ """
1400
+ ...
1017
1401
  def idcok(self, flag: bool) -> None: ...
1018
1402
  def idlok(self, yes: bool) -> None: ...
1019
1403
  def immedok(self, flag: bool) -> None: ...
1020
1404
  @overload
1021
- def inch(self) -> int: ...
1405
+ def inch(self) -> int:
1406
+ """
1407
+ inch([y, x])
1408
+ Return the character at the given position in the window.
1409
+
1410
+ y
1411
+ Y-coordinate.
1412
+ x
1413
+ X-coordinate.
1414
+
1415
+ The bottom 8 bits are the character proper, and upper bits are the attributes.
1416
+ """
1417
+ ...
1022
1418
  @overload
1023
- def inch(self, y: int, x: int) -> int: ...
1419
+ def inch(self, y: int, x: int) -> int:
1420
+ """
1421
+ inch([y, x])
1422
+ Return the character at the given position in the window.
1423
+
1424
+ y
1425
+ Y-coordinate.
1426
+ x
1427
+ X-coordinate.
1428
+
1429
+ The bottom 8 bits are the character proper, and upper bits are the attributes.
1430
+ """
1431
+ ...
1024
1432
  @overload
1025
- def insch(self, ch: _ChType, attr: int = ...) -> None: ...
1433
+ def insch(self, ch: _ChType, attr: int = ...) -> None:
1434
+ """
1435
+ insch([y, x,] ch, [attr=_curses.A_NORMAL])
1436
+ Insert a character before the current or specified position.
1437
+
1438
+ y
1439
+ Y-coordinate.
1440
+ x
1441
+ X-coordinate.
1442
+ ch
1443
+ Character to insert.
1444
+ attr
1445
+ Attributes for the character.
1446
+
1447
+ All characters to the right of the cursor are shifted one position right, with
1448
+ the rightmost characters on the line being lost.
1449
+ """
1450
+ ...
1026
1451
  @overload
1027
- def insch(self, y: int, x: int, ch: _ChType, attr: int = ...) -> None: ...
1452
+ def insch(self, y: int, x: int, ch: _ChType, attr: int = ...) -> None:
1453
+ """
1454
+ insch([y, x,] ch, [attr=_curses.A_NORMAL])
1455
+ Insert a character before the current or specified position.
1456
+
1457
+ y
1458
+ Y-coordinate.
1459
+ x
1460
+ X-coordinate.
1461
+ ch
1462
+ Character to insert.
1463
+ attr
1464
+ Attributes for the character.
1465
+
1466
+ All characters to the right of the cursor are shifted one position right, with
1467
+ the rightmost characters on the line being lost.
1468
+ """
1469
+ ...
1028
1470
  def insdelln(self, nlines: int) -> None: ...
1029
1471
  def insertln(self) -> None: ...
1030
1472
  @overload
1031
- def insnstr(self, str: str, n: int, attr: int = ...) -> None: ...
1473
+ def insnstr(self, str: str, n: int, attr: int = ...) -> None:
1474
+ """
1475
+ insnstr([y, x,] str, n, [attr])
1476
+ Insert at most n characters of the string.
1477
+
1478
+ y
1479
+ Y-coordinate.
1480
+ x
1481
+ X-coordinate.
1482
+ str
1483
+ String to insert.
1484
+ n
1485
+ Maximal number of characters.
1486
+ attr
1487
+ Attributes for characters.
1488
+
1489
+ Insert a character string (as many characters as will fit on the line)
1490
+ before the character under the cursor, up to n characters. If n is zero
1491
+ or negative, the entire string is inserted. All characters to the right
1492
+ of the cursor are shifted right, with the rightmost characters on the line
1493
+ being lost. The cursor position does not change (after moving to y, x, if
1494
+ specified).
1495
+ """
1496
+ ...
1032
1497
  @overload
1033
- def insnstr(self, y: int, x: int, str: str, n: int, attr: int = ...) -> None: ...
1498
+ def insnstr(self, y: int, x: int, str: str, n: int, attr: int = ...) -> None:
1499
+ """
1500
+ insnstr([y, x,] str, n, [attr])
1501
+ Insert at most n characters of the string.
1502
+
1503
+ y
1504
+ Y-coordinate.
1505
+ x
1506
+ X-coordinate.
1507
+ str
1508
+ String to insert.
1509
+ n
1510
+ Maximal number of characters.
1511
+ attr
1512
+ Attributes for characters.
1513
+
1514
+ Insert a character string (as many characters as will fit on the line)
1515
+ before the character under the cursor, up to n characters. If n is zero
1516
+ or negative, the entire string is inserted. All characters to the right
1517
+ of the cursor are shifted right, with the rightmost characters on the line
1518
+ being lost. The cursor position does not change (after moving to y, x, if
1519
+ specified).
1520
+ """
1521
+ ...
1034
1522
  @overload
1035
- def insstr(self, str: str, attr: int = ...) -> None: ...
1523
+ def insstr(self, str: str, attr: int = ...) -> None:
1524
+ """
1525
+ insstr([y, x,] str, [attr])
1526
+ Insert the string before the current or specified position.
1527
+
1528
+ y
1529
+ Y-coordinate.
1530
+ x
1531
+ X-coordinate.
1532
+ str
1533
+ String to insert.
1534
+ attr
1535
+ Attributes for characters.
1536
+
1537
+ Insert a character string (as many characters as will fit on the line)
1538
+ before the character under the cursor. All characters to the right of
1539
+ the cursor are shifted right, with the rightmost characters on the line
1540
+ being lost. The cursor position does not change (after moving to y, x,
1541
+ if specified).
1542
+ """
1543
+ ...
1036
1544
  @overload
1037
- def insstr(self, y: int, x: int, str: str, attr: int = ...) -> None: ...
1545
+ def insstr(self, y: int, x: int, str: str, attr: int = ...) -> None:
1546
+ """
1547
+ insstr([y, x,] str, [attr])
1548
+ Insert the string before the current or specified position.
1549
+
1550
+ y
1551
+ Y-coordinate.
1552
+ x
1553
+ X-coordinate.
1554
+ str
1555
+ String to insert.
1556
+ attr
1557
+ Attributes for characters.
1558
+
1559
+ Insert a character string (as many characters as will fit on the line)
1560
+ before the character under the cursor. All characters to the right of
1561
+ the cursor are shifted right, with the rightmost characters on the line
1562
+ being lost. The cursor position does not change (after moving to y, x,
1563
+ if specified).
1564
+ """
1565
+ ...
1038
1566
  @overload
1039
1567
  def instr(self, n: int = ...) -> bytes: ...
1040
1568
  @overload
1041
1569
  def instr(self, y: int, x: int, n: int = ...) -> bytes: ...
1042
- def is_linetouched(self, line: int, /) -> bool: ...
1570
+ def is_linetouched(self, line: int, /) -> bool:
1571
+ """
1572
+ Return True if the specified line was modified, otherwise return False.
1573
+
1574
+ line
1575
+ Line number.
1576
+
1577
+ Raise a curses.error exception if line is not valid for the given window.
1578
+ """
1579
+ ...
1043
1580
  def is_wintouched(self) -> bool: ...
1044
1581
  def keypad(self, yes: bool, /) -> None: ...
1045
1582
  def leaveok(self, yes: bool) -> None: ...
@@ -1049,53 +1586,309 @@ class _CursesWindow:
1049
1586
  def nodelay(self, yes: bool) -> None: ...
1050
1587
  def notimeout(self, yes: bool) -> None: ...
1051
1588
  @overload
1052
- def noutrefresh(self) -> None: ...
1589
+ def noutrefresh(self) -> None:
1590
+ """
1591
+ noutrefresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])
1592
+ Mark for refresh but wait.
1593
+
1594
+ This function updates the data structure representing the desired state of the
1595
+ window, but does not force an update of the physical screen. To accomplish
1596
+ that, call doupdate().
1597
+ """
1598
+ ...
1053
1599
  @overload
1054
- def noutrefresh(self, pminrow: int, pmincol: int, sminrow: int, smincol: int, smaxrow: int, smaxcol: int) -> None: ...
1600
+ def noutrefresh(self, pminrow: int, pmincol: int, sminrow: int, smincol: int, smaxrow: int, smaxcol: int) -> None:
1601
+ """
1602
+ noutrefresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])
1603
+ Mark for refresh but wait.
1604
+
1605
+ This function updates the data structure representing the desired state of the
1606
+ window, but does not force an update of the physical screen. To accomplish
1607
+ that, call doupdate().
1608
+ """
1609
+ ...
1055
1610
  @overload
1056
- def overlay(self, destwin: _CursesWindow) -> None: ...
1611
+ def overlay(self, destwin: window) -> None:
1612
+ """
1613
+ overlay(destwin, [sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])
1614
+ Overlay the window on top of destwin.
1615
+
1616
+ The windows need not be the same size, only the overlapping region is copied.
1617
+ This copy is non-destructive, which means that the current background
1618
+ character does not overwrite the old contents of destwin.
1619
+
1620
+ To get fine-grained control over the copied region, the second form of
1621
+ overlay() can be used. sminrow and smincol are the upper-left coordinates
1622
+ of the source window, and the other variables mark a rectangle in the
1623
+ destination window.
1624
+ """
1625
+ ...
1057
1626
  @overload
1058
1627
  def overlay(
1059
- self, destwin: _CursesWindow, sminrow: int, smincol: int, dminrow: int, dmincol: int, dmaxrow: int, dmaxcol: int
1060
- ) -> None: ...
1628
+ self, destwin: window, sminrow: int, smincol: int, dminrow: int, dmincol: int, dmaxrow: int, dmaxcol: int
1629
+ ) -> None:
1630
+ """
1631
+ overlay(destwin, [sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])
1632
+ Overlay the window on top of destwin.
1633
+
1634
+ The windows need not be the same size, only the overlapping region is copied.
1635
+ This copy is non-destructive, which means that the current background
1636
+ character does not overwrite the old contents of destwin.
1637
+
1638
+ To get fine-grained control over the copied region, the second form of
1639
+ overlay() can be used. sminrow and smincol are the upper-left coordinates
1640
+ of the source window, and the other variables mark a rectangle in the
1641
+ destination window.
1642
+ """
1643
+ ...
1061
1644
  @overload
1062
- def overwrite(self, destwin: _CursesWindow) -> None: ...
1645
+ def overwrite(self, destwin: window) -> None:
1646
+ """
1647
+ overwrite(destwin, [sminrow, smincol, dminrow, dmincol, dmaxrow,
1648
+ dmaxcol])
1649
+ Overwrite the window on top of destwin.
1650
+
1651
+ The windows need not be the same size, in which case only the overlapping
1652
+ region is copied. This copy is destructive, which means that the current
1653
+ background character overwrites the old contents of destwin.
1654
+
1655
+ To get fine-grained control over the copied region, the second form of
1656
+ overwrite() can be used. sminrow and smincol are the upper-left coordinates
1657
+ of the source window, the other variables mark a rectangle in the destination
1658
+ window.
1659
+ """
1660
+ ...
1063
1661
  @overload
1064
1662
  def overwrite(
1065
- self, destwin: _CursesWindow, sminrow: int, smincol: int, dminrow: int, dmincol: int, dmaxrow: int, dmaxcol: int
1066
- ) -> None: ...
1067
- def putwin(self, file: IO[Any], /) -> None: ...
1068
- def redrawln(self, beg: int, num: int, /) -> None: ...
1663
+ self, destwin: window, sminrow: int, smincol: int, dminrow: int, dmincol: int, dmaxrow: int, dmaxcol: int
1664
+ ) -> None:
1665
+ """
1666
+ overwrite(destwin, [sminrow, smincol, dminrow, dmincol, dmaxrow,
1667
+ dmaxcol])
1668
+ Overwrite the window on top of destwin.
1669
+
1670
+ The windows need not be the same size, in which case only the overlapping
1671
+ region is copied. This copy is destructive, which means that the current
1672
+ background character overwrites the old contents of destwin.
1673
+
1674
+ To get fine-grained control over the copied region, the second form of
1675
+ overwrite() can be used. sminrow and smincol are the upper-left coordinates
1676
+ of the source window, the other variables mark a rectangle in the destination
1677
+ window.
1678
+ """
1679
+ ...
1680
+ def putwin(self, file: IO[Any], /) -> None:
1681
+ """
1682
+ Write all data associated with the window into the provided file object.
1683
+
1684
+ This information can be later retrieved using the getwin() function.
1685
+ """
1686
+ ...
1687
+ def redrawln(self, beg: int, num: int, /) -> None:
1688
+ """
1689
+ Mark the specified lines corrupted.
1690
+
1691
+ beg
1692
+ Starting line number.
1693
+ num
1694
+ The number of lines.
1695
+
1696
+ They should be completely redrawn on the next refresh() call.
1697
+ """
1698
+ ...
1069
1699
  def redrawwin(self) -> None: ...
1070
1700
  @overload
1071
- def refresh(self) -> None: ...
1701
+ def refresh(self) -> None:
1702
+ """
1703
+ refresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])
1704
+ Update the display immediately.
1705
+
1706
+ Synchronize actual screen with previous drawing/deleting methods.
1707
+ The 6 optional arguments can only be specified when the window is a pad
1708
+ created with newpad(). The additional parameters are needed to indicate
1709
+ what part of the pad and screen are involved. pminrow and pmincol specify
1710
+ the upper left-hand corner of the rectangle to be displayed in the pad.
1711
+ sminrow, smincol, smaxrow, and smaxcol specify the edges of the rectangle to
1712
+ be displayed on the screen. The lower right-hand corner of the rectangle to
1713
+ be displayed in the pad is calculated from the screen coordinates, since the
1714
+ rectangles must be the same size. Both rectangles must be entirely contained
1715
+ within their respective structures. Negative values of pminrow, pmincol,
1716
+ sminrow, or smincol are treated as if they were zero.
1717
+ """
1718
+ ...
1072
1719
  @overload
1073
- def refresh(self, pminrow: int, pmincol: int, sminrow: int, smincol: int, smaxrow: int, smaxcol: int) -> None: ...
1720
+ def refresh(self, pminrow: int, pmincol: int, sminrow: int, smincol: int, smaxrow: int, smaxcol: int) -> None:
1721
+ """
1722
+ refresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])
1723
+ Update the display immediately.
1724
+
1725
+ Synchronize actual screen with previous drawing/deleting methods.
1726
+ The 6 optional arguments can only be specified when the window is a pad
1727
+ created with newpad(). The additional parameters are needed to indicate
1728
+ what part of the pad and screen are involved. pminrow and pmincol specify
1729
+ the upper left-hand corner of the rectangle to be displayed in the pad.
1730
+ sminrow, smincol, smaxrow, and smaxcol specify the edges of the rectangle to
1731
+ be displayed on the screen. The lower right-hand corner of the rectangle to
1732
+ be displayed in the pad is calculated from the screen coordinates, since the
1733
+ rectangles must be the same size. Both rectangles must be entirely contained
1734
+ within their respective structures. Negative values of pminrow, pmincol,
1735
+ sminrow, or smincol are treated as if they were zero.
1736
+ """
1737
+ ...
1074
1738
  def resize(self, nlines: int, ncols: int) -> None: ...
1075
- def scroll(self, lines: int = ...) -> None: ...
1739
+ def scroll(self, lines: int = ...) -> None:
1740
+ """
1741
+ scroll([lines=1])
1742
+ Scroll the screen or scrolling region.
1743
+
1744
+ lines
1745
+ Number of lines to scroll.
1746
+
1747
+ Scroll upward if the argument is positive and downward if it is negative.
1748
+ """
1749
+ ...
1076
1750
  def scrollok(self, flag: bool) -> None: ...
1077
- def setscrreg(self, top: int, bottom: int, /) -> None: ...
1751
+ def setscrreg(self, top: int, bottom: int, /) -> None:
1752
+ """
1753
+ Define a software scrolling region.
1754
+
1755
+ top
1756
+ First line number.
1757
+ bottom
1758
+ Last line number.
1759
+
1760
+ All scrolling actions will take place in this region.
1761
+ """
1762
+ ...
1078
1763
  def standend(self) -> None: ...
1079
1764
  def standout(self) -> None: ...
1080
1765
  @overload
1081
- def subpad(self, begin_y: int, begin_x: int) -> _CursesWindow: ...
1766
+ def subpad(self, begin_y: int, begin_x: int) -> window:
1767
+ """
1768
+ subwin([nlines=0, ncols=0,] begin_y, begin_x)
1769
+ Create a sub-window (screen-relative coordinates).
1770
+
1771
+ nlines
1772
+ Height.
1773
+ ncols
1774
+ Width.
1775
+ begin_y
1776
+ Top side y-coordinate.
1777
+ begin_x
1778
+ Left side x-coordinate.
1779
+
1780
+ By default, the sub-window will extend from the specified position to the
1781
+ lower right corner of the window.
1782
+ """
1783
+ ...
1082
1784
  @overload
1083
- def subpad(self, nlines: int, ncols: int, begin_y: int, begin_x: int) -> _CursesWindow: ...
1785
+ def subpad(self, nlines: int, ncols: int, begin_y: int, begin_x: int) -> window:
1786
+ """
1787
+ subwin([nlines=0, ncols=0,] begin_y, begin_x)
1788
+ Create a sub-window (screen-relative coordinates).
1789
+
1790
+ nlines
1791
+ Height.
1792
+ ncols
1793
+ Width.
1794
+ begin_y
1795
+ Top side y-coordinate.
1796
+ begin_x
1797
+ Left side x-coordinate.
1798
+
1799
+ By default, the sub-window will extend from the specified position to the
1800
+ lower right corner of the window.
1801
+ """
1802
+ ...
1084
1803
  @overload
1085
- def subwin(self, begin_y: int, begin_x: int) -> _CursesWindow: ...
1804
+ def subwin(self, begin_y: int, begin_x: int) -> window:
1805
+ """
1806
+ subwin([nlines=0, ncols=0,] begin_y, begin_x)
1807
+ Create a sub-window (screen-relative coordinates).
1808
+
1809
+ nlines
1810
+ Height.
1811
+ ncols
1812
+ Width.
1813
+ begin_y
1814
+ Top side y-coordinate.
1815
+ begin_x
1816
+ Left side x-coordinate.
1817
+
1818
+ By default, the sub-window will extend from the specified position to the
1819
+ lower right corner of the window.
1820
+ """
1821
+ ...
1086
1822
  @overload
1087
- def subwin(self, nlines: int, ncols: int, begin_y: int, begin_x: int) -> _CursesWindow: ...
1823
+ def subwin(self, nlines: int, ncols: int, begin_y: int, begin_x: int) -> window:
1824
+ """
1825
+ subwin([nlines=0, ncols=0,] begin_y, begin_x)
1826
+ Create a sub-window (screen-relative coordinates).
1827
+
1828
+ nlines
1829
+ Height.
1830
+ ncols
1831
+ Width.
1832
+ begin_y
1833
+ Top side y-coordinate.
1834
+ begin_x
1835
+ Left side x-coordinate.
1836
+
1837
+ By default, the sub-window will extend from the specified position to the
1838
+ lower right corner of the window.
1839
+ """
1840
+ ...
1088
1841
  def syncdown(self) -> None: ...
1089
1842
  def syncok(self, flag: bool) -> None: ...
1090
1843
  def syncup(self) -> None: ...
1091
1844
  def timeout(self, delay: int) -> None: ...
1092
- def touchline(self, start: int, count: int, changed: bool = ...) -> None: ...
1845
+ def touchline(self, start: int, count: int, changed: bool = ...) -> None:
1846
+ """
1847
+ touchline(start, count, [changed=True])
1848
+ Pretend count lines have been changed, starting with line start.
1849
+
1850
+ If changed is supplied, it specifies whether the affected lines are marked
1851
+ as having been changed (changed=True) or unchanged (changed=False).
1852
+ """
1853
+ ...
1093
1854
  def touchwin(self) -> None: ...
1094
1855
  def untouchwin(self) -> None: ...
1095
1856
  @overload
1096
- def vline(self, ch: _ChType, n: int) -> None: ...
1857
+ def vline(self, ch: _ChType, n: int) -> None:
1858
+ """
1859
+ vline([y, x,] ch, n, [attr=_curses.A_NORMAL])
1860
+ Display a vertical line.
1861
+
1862
+ y
1863
+ Starting Y-coordinate.
1864
+ x
1865
+ Starting X-coordinate.
1866
+ ch
1867
+ Character to draw.
1868
+ n
1869
+ Line length.
1870
+ attr
1871
+ Attributes for the character.
1872
+ """
1873
+ ...
1097
1874
  @overload
1098
- def vline(self, y: int, x: int, ch: _ChType, n: int) -> None: ...
1875
+ def vline(self, y: int, x: int, ch: _ChType, n: int) -> None:
1876
+ """
1877
+ vline([y, x,] ch, n, [attr=_curses.A_NORMAL])
1878
+ Display a vertical line.
1879
+
1880
+ y
1881
+ Starting Y-coordinate.
1882
+ x
1883
+ Starting X-coordinate.
1884
+ ch
1885
+ Character to draw.
1886
+ n
1887
+ Line length.
1888
+ attr
1889
+ Attributes for the character.
1890
+ """
1891
+ ...
1099
1892
 
1100
1893
  class _ncurses_version(NamedTuple):
1101
1894
  major: int
@@ -1103,4 +1896,3 @@ class _ncurses_version(NamedTuple):
1103
1896
  patch: int
1104
1897
 
1105
1898
  ncurses_version: _ncurses_version
1106
- window = _CursesWindow # undocumented