Skip to content

Commit f0007f8

Browse files
committed
chore: update Python stubs
1 parent aa3cbfc commit f0007f8

File tree

2 files changed

+48
-78
lines changed

2 files changed

+48
-78
lines changed

pyudmaio/pyudmaio/__init__.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ from pyudmaio.binding import UioDeviceLocation
1313
from pyudmaio.binding import UioIf
1414
from pyudmaio.binding import UioMemSgdma
1515
from pyudmaio.binding import UioRegion
16-
from pyudmaio.binding import set_logging_level
16+
from pyudmaio.binding.pybind11_detail_function_record_v1_system_libstdcpp_gxx_abi_1xxx_use_cxx11_abi_1 import set_logging_level
1717
from . import _UioReg
1818
from . import binding
1919
__all__ = ['ConfigUio', 'ConfigXdma', 'DataHandler', 'FpgaMemBufferOverAxi', 'FpgaMemBufferOverXdma', 'FrameFormat', 'LogLevel', 'UDmaBuf', 'UioAxiDmaIf', 'UioDeviceLocation', 'UioIf', 'UioMemSgdma', 'UioReg', 'UioRegion', 'binding', 'set_logging_level']

pyudmaio/pyudmaio/binding.pyi

Lines changed: 47 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,43 @@
11
from __future__ import annotations
2+
import numpy
3+
import numpy.typing
24
import typing
35
__all__ = ['ConfigBase', 'ConfigUio', 'ConfigXdma', 'DEBUG', 'DataHandler', 'DmaBufferAbstract', 'FATAL', 'FpgaMemBufferOverAxi', 'FpgaMemBufferOverXdma', 'FrameFormat', 'HwAccessor', 'INFO', 'LogLevel', 'TRACE', 'UDmaBuf', 'UioAxiDmaIf', 'UioDeviceLocation', 'UioIf', 'UioMemSgdma', 'UioRegion', 'set_logging_level']
46
class ConfigBase:
57
"""
68
Base class for HwAccessor creation
79
"""
8-
@staticmethod
9-
def _pybind11_conduit_v1_(*args, **kwargs):
10-
...
1110
def hw_acc(self, arg0: UioDeviceLocation) -> HwAccessor:
1211
...
1312
class ConfigUio(ConfigBase):
1413
"""
1514
Creates HwAccessor from UioDeviceLocation (UIO version)
1615
"""
17-
@staticmethod
18-
def _pybind11_conduit_v1_(*args, **kwargs):
19-
...
2016
def __init__(self) -> None:
2117
...
2218
class ConfigXdma(ConfigBase):
2319
"""
2420
Creates HwAccessor from UioDeviceLocation (XDMA version)
2521
"""
26-
@staticmethod
27-
def _pybind11_conduit_v1_(*args, **kwargs):
28-
...
29-
def __init__(self, xdma_path: str, pcie_offs: int, x7_series_mode: bool = False) -> None:
22+
def __init__(self, xdma_path: str, pcie_offs: typing.SupportsInt, x7_series_mode: bool = False) -> None:
3023
...
3124
class DataHandler:
3225
"""
3326
"""
34-
@staticmethod
35-
def _pybind11_conduit_v1_(*args, **kwargs):
36-
...
37-
def __init__(self, dma: UioAxiDmaIf, desc: UioMemSgdma, mem: DmaBufferAbstract, receive_packets: bool = True, queue_size: int = 64, rt_prio: bool = False) -> None:
27+
def __init__(self, dma: UioAxiDmaIf, desc: UioMemSgdma, mem: DmaBufferAbstract, receive_packets: bool = True, queue_size: typing.SupportsInt = 64, rt_prio: bool = False) -> None:
3828
...
39-
def read(self, ms_timeout: int) -> numpy.ndarray[numpy.uint8]:
29+
def read(self, ms_timeout: typing.SupportsInt) -> numpy.typing.NDArray[numpy.uint8]:
4030
...
41-
def read_nb(self) -> numpy.ndarray[numpy.uint8]:
31+
def read_nb(self) -> numpy.typing.NDArray[numpy.uint8]:
4232
...
43-
def start(self, nr_pkts: int, pkt_size: int, init_only: bool = False) -> None:
33+
def start(self, nr_pkts: typing.SupportsInt, pkt_size: typing.SupportsInt, init_only: bool = False) -> None:
4434
...
4535
def stop(self) -> None:
4636
...
4737
class DmaBufferAbstract:
4838
"""
4939
Base class for DMA data buffer
5040
"""
51-
@staticmethod
52-
def _pybind11_conduit_v1_(*args, **kwargs):
53-
...
5441
def get_phys_region(self) -> UioRegion:
5542
"""
5643
Get physical region
@@ -63,19 +50,13 @@ class FpgaMemBufferOverAxi(DmaBufferAbstract, UioIf):
6350
DMA data buffer accessed over AXI/UIO, described w/ explicit address &
6451
size
6552
"""
66-
@staticmethod
67-
def _pybind11_conduit_v1_(*args, **kwargs):
68-
...
6953
def __init__(self, arg0: UioDeviceLocation) -> None:
7054
...
7155
class FpgaMemBufferOverXdma(DmaBufferAbstract):
7256
"""
7357
DMA data buffer accessed over XDMA using the xdma c2h0 stream channel
7458
"""
75-
@staticmethod
76-
def _pybind11_conduit_v1_(*args, **kwargs):
77-
...
78-
def __init__(self, arg0: str, arg1: int) -> None:
59+
def __init__(self, arg0: str, arg1: typing.SupportsInt) -> None:
7960
"""
8061
Constructs a DMA data buffer
8162
@@ -92,12 +73,19 @@ class FrameFormat:
9273
"""
9374
Frame dimensions
9475
"""
95-
height: int
96-
width: int
97-
@staticmethod
98-
def _pybind11_conduit_v1_(*args, **kwargs):
76+
def __init__(self, arg0: typing.SupportsInt, arg1: typing.SupportsInt) -> None:
9977
...
100-
def __init__(self, arg0: int, arg1: int) -> None:
78+
@property
79+
def height(self) -> int:
80+
...
81+
@height.setter
82+
def height(self, arg0: typing.SupportsInt) -> None:
83+
...
84+
@property
85+
def width(self) -> int:
86+
...
87+
@width.setter
88+
def width(self, arg0: typing.SupportsInt) -> None:
10189
...
10290
class PixelFormat:
10391
"""
@@ -223,9 +211,6 @@ class FrameFormat:
223211
YUV8_UYV: typing.ClassVar[FrameFormat.PixelFormat] # value = <PixelFormat.YUV8_UYV: 35127328>
224212
__members__: typing.ClassVar[dict[str, FrameFormat.PixelFormat]] # value = {'unknown': <PixelFormat.unknown: 0>, 'Mono8': <PixelFormat.Mono8: 17301505>, 'Mono10': <PixelFormat.Mono10: 17825795>, 'Mono12': <PixelFormat.Mono12: 17825797>, 'Mono14': <PixelFormat.Mono14: 17825829>, 'Mono16': <PixelFormat.Mono16: 17825799>, 'BayerGR8': <PixelFormat.BayerGR8: 17301512>, 'BayerRG8': <PixelFormat.BayerRG8: 17301513>, 'BayerGB8': <PixelFormat.BayerGB8: 17301514>, 'BayerBG8': <PixelFormat.BayerBG8: 17301515>, 'BayerGR10': <PixelFormat.BayerGR10: 17825804>, 'BayerRG10': <PixelFormat.BayerRG10: 17825805>, 'BayerGB10': <PixelFormat.BayerGB10: 17825806>, 'BayerBG10': <PixelFormat.BayerBG10: 17825807>, 'BayerGR12': <PixelFormat.BayerGR12: 17825808>, 'BayerRG12': <PixelFormat.BayerRG12: 17825809>, 'BayerGB12': <PixelFormat.BayerGB12: 17825810>, 'BayerBG12': <PixelFormat.BayerBG12: 17825811>, 'RGB8': <PixelFormat.RGB8: 35127316>, 'BGR8': <PixelFormat.BGR8: 35127317>, 'RGBa8': <PixelFormat.RGBa8: 35651606>, 'BGRa8': <PixelFormat.BGRa8: 35651607>, 'RGB10V1Packed1': <PixelFormat.RGB10V1Packed1: 35651612>, 'RGB10p32': <PixelFormat.RGB10p32: 35651613>, 'RGB565p': <PixelFormat.RGB565p: 34603061>, 'BGR565p': <PixelFormat.BGR565p: 34603062>, 'YUV422_8_UYVY': <PixelFormat.YUV422_8_UYVY: 34603039>, 'YUV422_8': <PixelFormat.YUV422_8: 34603058>, 'YUV8_UYV': <PixelFormat.YUV8_UYV: 35127328>, 'YCbCr8_CbYCr': <PixelFormat.YCbCr8_CbYCr: 35127354>, 'YCbCr422_8': <PixelFormat.YCbCr422_8: 34603067>, 'YCbCr422_8_CbYCrY': <PixelFormat.YCbCr422_8_CbYCrY: 34603075>, 'YCbCr601_8_CbYCr': <PixelFormat.YCbCr601_8_CbYCr: 35127357>, 'YCbCr601_422_8': <PixelFormat.YCbCr601_422_8: 34603070>, 'YCbCr601_422_8_CbYCrY': <PixelFormat.YCbCr601_422_8_CbYCrY: 34603076>, 'YCbCr709_8_CbYCr': <PixelFormat.YCbCr709_8_CbYCr: 35127360>, 'YCbCr709_422_8': <PixelFormat.YCbCr709_422_8: 34603073>, 'YCbCr709_422_8_CbYCrY': <PixelFormat.YCbCr709_422_8_CbYCrY: 34603077>, 'RGB8_Planar': <PixelFormat.RGB8_Planar: 35127329>}
225213
unknown: typing.ClassVar[FrameFormat.PixelFormat] # value = <PixelFormat.unknown: 0>
226-
@staticmethod
227-
def _pybind11_conduit_v1_(*args, **kwargs):
228-
...
229214
def __eq__(self, other: typing.Any) -> bool:
230215
...
231216
def __getstate__(self) -> int:
@@ -234,15 +219,15 @@ class FrameFormat:
234219
...
235220
def __index__(self) -> int:
236221
...
237-
def __init__(self, value: int) -> None:
222+
def __init__(self, value: typing.SupportsInt) -> None:
238223
...
239224
def __int__(self) -> int:
240225
...
241226
def __ne__(self, other: typing.Any) -> bool:
242227
...
243228
def __repr__(self) -> str:
244229
...
245-
def __setstate__(self, state: int) -> None:
230+
def __setstate__(self, state: typing.SupportsInt) -> None:
246231
...
247232
def __str__(self) -> str:
248233
...
@@ -291,9 +276,6 @@ class FrameFormat:
291276
YUV422_8_UYVY: typing.ClassVar[FrameFormat.PixelFormat] # value = <PixelFormat.YUV422_8_UYVY: 34603039>
292277
YUV8_UYV: typing.ClassVar[FrameFormat.PixelFormat] # value = <PixelFormat.YUV8_UYV: 35127328>
293278
unknown: typing.ClassVar[FrameFormat.PixelFormat] # value = <PixelFormat.unknown: 0>
294-
@staticmethod
295-
def _pybind11_conduit_v1_(*args, **kwargs):
296-
...
297279
def __init__(self) -> None:
298280
...
299281
def get_bytes_per_pixel(self) -> int:
@@ -312,29 +294,26 @@ class FrameFormat:
312294
...
313295
def get_word_width(self) -> int:
314296
...
315-
def set_bpp(self, arg0: int) -> None:
297+
def set_bpp(self, arg0: typing.SupportsInt) -> None:
316298
...
317299
def set_dim(self, arg0: FrameFormat.Dim) -> None:
318300
...
319301
@typing.overload
320-
def set_format(self, dim: FrameFormat.Dim, bytes_per_pixel: int, word_width: int = 4) -> None:
302+
def set_format(self, dim: FrameFormat.Dim, bytes_per_pixel: typing.SupportsInt, word_width: typing.SupportsInt = 4) -> None:
321303
...
322304
@typing.overload
323-
def set_format(self, dim: FrameFormat.Dim, pix_fmt_str: str, word_width: int = 4) -> None:
305+
def set_format(self, dim: FrameFormat.Dim, pix_fmt_str: str, word_width: typing.SupportsInt = 4) -> None:
324306
...
325307
@typing.overload
326-
def set_format(self, dim: FrameFormat.Dim, pix_fmt: FrameFormat.PixelFormat, word_width: int = 4) -> None:
308+
def set_format(self, dim: FrameFormat.Dim, pix_fmt: FrameFormat.PixelFormat, word_width: typing.SupportsInt = 4) -> None:
327309
...
328310
def set_pix_fmt(self, arg0: FrameFormat.PixelFormat) -> None:
329311
...
330-
def set_word_width(self, arg0: int) -> None:
312+
def set_word_width(self, arg0: typing.SupportsInt) -> None:
331313
...
332314
class HwAccessor:
333315
"""
334316
"""
335-
@staticmethod
336-
def _pybind11_conduit_v1_(*args, **kwargs):
337-
...
338317
class LogLevel:
339318
"""
340319
Members:
@@ -352,9 +331,6 @@ class LogLevel:
352331
INFO: typing.ClassVar[LogLevel] # value = <LogLevel.INFO: 2>
353332
TRACE: typing.ClassVar[LogLevel] # value = <LogLevel.TRACE: 0>
354333
__members__: typing.ClassVar[dict[str, LogLevel]] # value = {'FATAL': <LogLevel.FATAL: 5>, 'INFO': <LogLevel.INFO: 2>, 'DEBUG': <LogLevel.DEBUG: 1>, 'TRACE': <LogLevel.TRACE: 0>}
355-
@staticmethod
356-
def _pybind11_conduit_v1_(*args, **kwargs):
357-
...
358334
def __eq__(self, other: typing.Any) -> bool:
359335
...
360336
def __getstate__(self) -> int:
@@ -363,15 +339,15 @@ class LogLevel:
363339
...
364340
def __index__(self) -> int:
365341
...
366-
def __init__(self, value: int) -> None:
342+
def __init__(self, value: typing.SupportsInt) -> None:
367343
...
368344
def __int__(self) -> int:
369345
...
370346
def __ne__(self, other: typing.Any) -> bool:
371347
...
372348
def __repr__(self) -> str:
373349
...
374-
def __setstate__(self, state: int) -> None:
350+
def __setstate__(self, state: typing.SupportsInt) -> None:
375351
...
376352
def __str__(self) -> str:
377353
...
@@ -386,10 +362,7 @@ class UDmaBuf(DmaBufferAbstract):
386362
DMA data buffer accessed over AXI/UIO, implemented w/ udmabuf (see
387363
https://github.com/ikwzm/udmabuf)
388364
"""
389-
@staticmethod
390-
def _pybind11_conduit_v1_(*args, **kwargs):
391-
...
392-
def __init__(self, buf_idx: int = 0) -> None:
365+
def __init__(self, buf_idx: typing.SupportsInt = 0) -> None:
393366
"""
394367
Constructs a UDmaBuf
395368
@@ -400,9 +373,6 @@ class UioAxiDmaIf(UioIf):
400373
"""
401374
Interface to AXI DMA Core
402375
"""
403-
@staticmethod
404-
def _pybind11_conduit_v1_(*args, **kwargs):
405-
...
406376
def __init__(self, arg0: UioDeviceLocation) -> None:
407377
...
408378
def dump_status(self) -> None:
@@ -414,15 +384,12 @@ class UioDeviceLocation:
414384
Holds information where a device can be found over both UIO and XDMA
415385
"""
416386
@staticmethod
417-
def _pybind11_conduit_v1_(*args, **kwargs):
418-
...
419-
@staticmethod
420387
def set_link_axi() -> None:
421388
"""
422389
Set UioIf's globally to use a AXI/UIO link
423390
"""
424391
@staticmethod
425-
def set_link_xdma(arg0: str, arg1: int, arg2: bool) -> None:
392+
def set_link_xdma(arg0: str, arg1: typing.SupportsInt, arg2: bool) -> None:
426393
"""
427394
Set UioIf's globally to use a XDMA link
428395
@@ -468,27 +435,23 @@ class UioIf:
468435
"""
469436
Base class for UIO interfaces
470437
"""
471-
@staticmethod
472-
def _pybind11_conduit_v1_(*args, **kwargs):
473-
...
474438
def __init__(self, arg0: str, arg1: UioDeviceLocation) -> None:
475439
...
476-
def _rd32(self, arg0: int) -> int:
440+
def _rd32(self, arg0: typing.SupportsInt) -> int:
477441
...
478-
def _wr32(self, arg0: int, arg1: int) -> None:
442+
def _wr32(self, arg0: typing.SupportsInt, arg1: typing.SupportsInt) -> None:
479443
...
480444
def arm_interrupt(self) -> None:
481445
...
446+
def read_bulk(self, arg0: typing.SupportsInt, arg1: typing.SupportsInt) -> numpy.typing.NDArray[numpy.uint8]:
447+
...
482448
def wait_for_interrupt(self) -> int:
483449
...
484450
class UioMemSgdma(UioIf):
485451
"""
486452
Interface to AXI DMA scatter-gather buffers & descriptors Uses a UioIf
487453
to access DMA descriptor memory
488454
"""
489-
@staticmethod
490-
def _pybind11_conduit_v1_(*args, **kwargs):
491-
...
492455
def __init__(self, arg0: UioDeviceLocation) -> None:
493456
...
494457
def print_descs(self) -> None:
@@ -499,12 +462,19 @@ class UioRegion:
499462
"""
500463
General-purpose struct to define a memory area
501464
"""
502-
addr: int
503-
size: int
504-
@staticmethod
505-
def _pybind11_conduit_v1_(*args, **kwargs):
465+
def __init__(self, arg0: typing.SupportsInt, arg1: typing.SupportsInt) -> None:
466+
...
467+
@property
468+
def addr(self) -> int:
469+
...
470+
@addr.setter
471+
def addr(self, arg0: typing.SupportsInt) -> None:
472+
...
473+
@property
474+
def size(self) -> int:
506475
...
507-
def __init__(self, arg0: int, arg1: int) -> None:
476+
@size.setter
477+
def size(self, arg0: typing.SupportsInt) -> None:
508478
...
509479
def set_logging_level(arg0: LogLevel) -> None:
510480
...

0 commit comments

Comments
 (0)