Add some exports, define __all__ in all modules.

Author: sebpuetz

src/finalfusion/__init__.py

@@ -2,4 +2,14 @@
 Finalfusion embeddings in Python
 """
 
+from finalfusion.compat import load_fasttext, load_text, load_text_dims, load_word2vec
 from finalfusion.embeddings import Embeddings, load_finalfusion
+from finalfusion.metadata import Metadata, load_metadata
+from finalfusion.storage import Storage, load_storage
+from finalfusion.vocab import Vocab, load_vocab
+
+__all__ = [
+    'load_fasttext', 'load_text', 'load_text_dims', 'load_word2vec',
+    'Embeddings', 'load_finalfusion', 'Metadata', 'load_metadata', 'Storage',
+    'load_storage', 'Vocab', 'load_vocab'
+]

src/finalfusion/_util.py

@@ -1,4 +1,6 @@
 # pylint: disable=missing-module-docstring
+from typing import List
+
 import numpy as np
 
 from finalfusion.norms import Norms
@@ -8,3 +10,6 @@ def _normalize_matrix(storage: np.ndarray) -> Norms:
     norms = np.linalg.norm(storage, axis=1)
     storage /= norms[:, None]
     return Norms(norms)
+
+
+__all__ = []  # type: List[str]

src/finalfusion/compat/fasttext.py

@@ -8,8 +8,8 @@
 
 import numpy as np
 
-from finalfusion import Embeddings
 from finalfusion._util import _normalize_matrix
+from finalfusion.embeddings import Embeddings
 from finalfusion.io import _read_required_binary, _write_binary, _serialize_array_as_le
 from finalfusion.metadata import Metadata
 from finalfusion.storage import NdArray

src/finalfusion/compat/text.py

@@ -8,7 +8,7 @@
 
 import numpy as np
 
-from finalfusion import Embeddings
+from finalfusion.embeddings import Embeddings
 from finalfusion._util import _normalize_matrix
 from finalfusion.storage import NdArray
 from finalfusion.vocab import SimpleVocab

src/finalfusion/compat/word2vec.py

@@ -8,7 +8,7 @@
 
 import numpy as np
 
-from finalfusion import Embeddings
+from finalfusion.embeddings import Embeddings
 from finalfusion.io import _serialize_array_as_le
 from finalfusion.storage import NdArray
 from finalfusion._util import _normalize_matrix

src/finalfusion/embeddings.py

@@ -672,3 +672,6 @@ class SimilarityResult:
     """
     word: str = field(compare=False)
     similarity: float
+
+
+__all__ = ['Embeddings', 'SimilarityResult', 'load_finalfusion']

src/finalfusion/io.py

@@ -332,3 +332,7 @@ def _read_array_as_native(file: BinaryIO, dtype: np.dtype,
     if sys.byteorder == "big":
         array.byteswap(inplace=True)
     return array
+
+
+# export nothing from this module since it's not part of the public API
+__all__ = []  # type: List[str]

src/finalfusion/norms.py

@@ -108,3 +108,6 @@ def load_norms(file: Union[str, bytes, int, PathLike]):
         if chunk == ChunkIdentifier.NdNorms:
             return Norms.read_chunk(inf)
         raise ValueError(f"Unexpected chunk: {str(chunk)}")
+
+
+__all__ = ['Norms', 'load_norms']

src/finalfusion/storage/__init__.py

@@ -48,3 +48,9 @@ def load_storage(file: Union[str, bytes, int, PathLike],
                 return QuantizedArray.mmap_chunk(inf)
             return QuantizedArray.read_chunk(inf)
         raise NotImplementedError('Storage type is not yet supported.')
+
+
+__all__ = [
+    'Storage', 'load_storage', 'QuantizedArray', 'load_quantized_array',
+    'NdArray', 'load_ndarray'
+]

src/finalfusion/storage/ndarray.py

@@ -157,3 +157,6 @@ def load_ndarray(file: Union[str, bytes, int, PathLike],
                 return NdArray.mmap_chunk(inf)
             return NdArray.read_chunk(inf)
         raise ValueError(f"unknown storage type: {chunk}")
+
+
+__all__ = ['NdArray', 'load_ndarray']