Skip to content

Commit 8f95a33

Browse files
committed
Explain _loci proxy importing and pdoc
1 parent 97454a9 commit 8f95a33

2 files changed

Lines changed: 16 additions & 1 deletion

File tree

src/imcflibs/imagej/_loci.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@
77
88
By stashing this into an internal submodule only checks on this specific
99
(minimalistic) file will fail but remain operational for the other code.
10+
11+
So why are the other imports in here then?
12+
13+
This was a conscious decision as it seems to be confusing that *some* parts from
14+
the `loci` package need to be imported from the `imcflibs.imagej._loci`
15+
sub-module while others are imported directly. Instead we're simply importing
16+
proxy-style all loci components through the file here.
17+
18+
NOTE: the actual import of `ImporterOptions` still requires the `# pdoc: skip`
19+
pragma to work with the documentation generation scripts, e.g.
20+
21+
```
22+
from ._loci import ImporterOptions # pdoc: skip
23+
```
1024
"""
1125

1226
from loci.plugins import BF

src/imcflibs/imagej/bioformats.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414

1515
from ij import IJ
1616

17-
from ._loci import BF, ImporterOptions, ImageReader, Memoizer
17+
from ._loci import ImporterOptions # pdoc: skip
18+
from ._loci import BF, ImageReader, Memoizer
1819

1920
from ..pathtools import gen_name_from_orig
2021
from ..log import LOG as log

0 commit comments

Comments
 (0)