Skip to content

Commit a3d60c1

Browse files
authored
Rename underscore-prefixed binding factory functions to make_something
Differential Revision: D102682526 Pull Request resolved: #1384
1 parent a909cbf commit a3d60c1

8 files changed

Lines changed: 52 additions & 21 deletions

File tree

src/spdl/io/_core.py

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,11 @@ def __init__(
164164
name: str | None = None,
165165
**kwargs: Any,
166166
) -> None:
167-
self._demuxer: _libspdl.Demuxer = _libspdl._demuxer(
168-
_resolve_src(src), demux_config=demux_config, name=name, **kwargs
167+
self._demuxer: _libspdl.Demuxer = _libspdl.make_demuxer(
168+
_resolve_src(src),
169+
demux_config=demux_config,
170+
name=name,
171+
**kwargs, # pyre-ignore[6]
169172
)
170173

171174
def demux_audio(
@@ -461,7 +464,7 @@ class BSF(Generic[TCodec, TPackets]):
461464
"""
462465

463466
def __init__(self, codec: TCodec, bsf: str) -> None:
464-
self._bsf: Any = _libspdl._make_bsf(codec, bsf)
467+
self._bsf: Any = _libspdl.make_bsf(codec, bsf) # pyre-ignore[6]
465468

466469
def filter(self, packets: TPackets, flush: bool = False) -> TPackets | None:
467470
"""Apply the filter to the input packets
@@ -621,8 +624,10 @@ def Decoder(
621624
if filter_desc is not None:
622625
filter_desc = _resolve_filter_graph(filter_desc, codec)
623626

624-
return _libspdl._make_decoder(
625-
codec, filter_desc=filter_desc, decode_config=decode_config
627+
return _libspdl.make_decoder(
628+
codec,
629+
filter_desc=filter_desc,
630+
decode_config=decode_config, # pyre-ignore[6]
626631
)
627632

628633

@@ -893,7 +898,7 @@ def decode_image_nvjpeg(
893898

894899
def _get_decoder() -> "NvDecDecoder":
895900
if getattr(_THREAD_LOCAL, "_decoder", None) is None:
896-
_THREAD_LOCAL._decoder = _libspdl_cuda._nvdec_decoder() # pyre-ignore[16]
901+
_THREAD_LOCAL._decoder = _libspdl_cuda.make_nvdec_decoder() # pyre-ignore[16]
897902
return _THREAD_LOCAL._decoder
898903

899904

src/spdl/io/lib/_libspdl.pyi

Lines changed: 24 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/spdl/io/lib/_libspdl_cuda.pyi

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/spdl/io/lib/core/bsf.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,19 +60,19 @@ void register_bsf(nb::module_& m) {
6060
nb::call_guard<nb::gil_scoped_release>());
6161

6262
m.def(
63-
"_make_bsf",
63+
"make_bsf",
6464
[](const VideoCodec& codec, const std::string& name) {
6565
return std::make_unique<BSF<MediaType::Video>>(codec, name);
6666
},
6767
nb::call_guard<nb::gil_scoped_release>());
6868
m.def(
69-
"_make_bsf",
69+
"make_bsf",
7070
[](const AudioCodec& codec, const std::string& name) {
7171
return std::make_unique<BSF<MediaType::Audio>>(codec, name);
7272
},
7373
nb::call_guard<nb::gil_scoped_release>());
7474
m.def(
75-
"_make_bsf",
75+
"make_bsf",
7676
[](const ImageCodec& codec, const std::string& name) {
7777
return std::make_unique<BSF<MediaType::Image>>(codec, name);
7878
},

src/spdl/io/lib/core/decoding.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,23 +95,23 @@ void register_decoding(nb::module_& m) {
9595
"Flush the decoder and yield remaining frames");
9696

9797
m.def(
98-
"_make_decoder",
98+
"make_decoder",
9999
&_make_decoder<MediaType::Audio>,
100100
nb::call_guard<nb::gil_scoped_release>(),
101101
nb::arg("codec"),
102102
nb::kw_only(),
103103
nb::arg("decode_config") = nb::none(),
104104
nb::arg("filter_desc") = nb::none());
105105
m.def(
106-
"_make_decoder",
106+
"make_decoder",
107107
&_make_decoder<MediaType::Video>,
108108
nb::call_guard<nb::gil_scoped_release>(),
109109
nb::arg("codec"),
110110
nb::kw_only(),
111111
nb::arg("decode_config") = nb::none(),
112112
nb::arg("filter_desc") = nb::none());
113113
m.def(
114-
"_make_decoder",
114+
"make_decoder",
115115
&_make_decoder<MediaType::Image>,
116116
nb::call_guard<nb::gil_scoped_release>(),
117117
nb::arg("codec"),

src/spdl/io/lib/core/demuxing.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ void register_demuxing(nb::module_& m) {
312312
.def("_drop", &PyDemuxer::_drop);
313313

314314
m.def(
315-
"_demuxer",
315+
"make_demuxer",
316316
&_make_demuxer,
317317
nb::arg("src"),
318318
nb::kw_only(),
@@ -321,7 +321,7 @@ void register_demuxing(nb::module_& m) {
321321
nb::arg("name") = nb::none());
322322

323323
m.def(
324-
"_demuxer",
324+
"make_demuxer",
325325
&_make_demuxer_memoryview,
326326
nb::arg("src"),
327327
nb::kw_only(),

src/spdl/io/lib/cuda/decoding_nvdec.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ The frame buffer must be initialized with init_buffer() before calling this.
272272
nb::call_guard<nb::gil_scoped_release>());
273273

274274
m.def(
275-
"_nvdec_decoder",
275+
"make_nvdec_decoder",
276276
[]() -> std::unique_ptr<NvDecDecoder> {
277277
#ifdef SPDL_USE_NVCODEC
278278
return std::make_unique<NvDecDecoder>();

tests/cuda/nvdec_video_decoding_test.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ def tearDown(self) -> None:
323323
# Clean up any cached decoders after each test
324324
spdl.io._core._del_cached_decoder()
325325

326-
@patch("spdl.io._core._libspdl_cuda._nvdec_decoder")
326+
@patch("spdl.io._core._libspdl_cuda.make_nvdec_decoder")
327327
def test_decoder_caching_same_thread(self, mock_nvdec_decoder: MagicMock) -> None:
328328
"""Verify that nvdec_decoder returns the same cached instance within the same thread."""
329329
# Setup: Mock decoder creation to return a mock object
@@ -343,7 +343,7 @@ def test_decoder_caching_same_thread(self, mock_nvdec_decoder: MagicMock) -> Non
343343
mock_nvdec_decoder.call_count, 1, "Decoder should be created only once"
344344
)
345345

346-
@patch("spdl.io._core._libspdl_cuda._nvdec_decoder")
346+
@patch("spdl.io._core._libspdl_cuda.make_nvdec_decoder")
347347
def test_decoder_no_caching(self, mock_nvdec_decoder: MagicMock) -> None:
348348
"""Verify that nvdec_decoder creates a new instance when use_cache=False."""
349349
# Setup: Mock decoder creation to return different mock objects each time
@@ -366,7 +366,7 @@ def test_decoder_no_caching(self, mock_nvdec_decoder: MagicMock) -> None:
366366
mock_nvdec_decoder.call_count, 2, "Decoder should be created twice"
367367
)
368368

369-
@patch("spdl.io._core._libspdl_cuda._nvdec_decoder")
369+
@patch("spdl.io._core._libspdl_cuda.make_nvdec_decoder")
370370
def test_decoder_caching_different_threads(
371371
self, mock_nvdec_decoder: MagicMock
372372
) -> None:
@@ -412,7 +412,7 @@ def get_decoder_in_thread():
412412
creation_count["count"], 2, "Decoder should be created once per thread"
413413
)
414414

415-
@patch("spdl.io._core._libspdl_cuda._nvdec_decoder")
415+
@patch("spdl.io._core._libspdl_cuda.make_nvdec_decoder")
416416
def test_decoder_cache_cleared_on_crop(self, mock_nvdec_decoder: MagicMock) -> None:
417417
"""Verify that providing crop parameters forces recreation of the decoder.
418418
@@ -449,7 +449,7 @@ def test_decoder_cache_cleared_on_crop(self, mock_nvdec_decoder: MagicMock) -> N
449449
"Decoder should be recreated when crop parameters change",
450450
)
451451

452-
@patch("spdl.io._core._libspdl_cuda._nvdec_decoder")
452+
@patch("spdl.io._core._libspdl_cuda.make_nvdec_decoder")
453453
def test_cache_cleanup_with_hasattr_delattr(
454454
self, mock_nvdec_decoder: MagicMock
455455
) -> None:
@@ -471,7 +471,7 @@ def test_cache_cleanup_with_hasattr_delattr(
471471
"Decoder should be created twice after cache clear",
472472
)
473473

474-
@patch("spdl.io._core._libspdl_cuda._nvdec_decoder")
474+
@patch("spdl.io._core._libspdl_cuda.make_nvdec_decoder")
475475
def test_thread_local_isolation_with_getattr(
476476
self, mock_nvdec_decoder: MagicMock
477477
) -> None:

0 commit comments

Comments
 (0)