Changeset f619de7 in sasmodels for sasmodels/core.py

Timestamp:

Apr 11, 2016 9:14:50 AM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

7ae2b7f

Parents:

9a943d0

Message:

more type hinting

File:

• sasmodels/core.py (modified) (6 diffs)

sasmodels/core.py

@@ -26 +26 @@
     HAVE_OPENCL = False
 
+try:
+    from typing import List, Union, Optional, Any
+    DType = Union[None, str, np.dtype]
+    from .kernel import KernelModel
+except ImportError:
+    pass
+
+
 # TODO: refactor composite model support
 # The current load_model_info/build_model does not reuse existing model
@@ -39 +47 @@
 
 def list_models():
+    # type: () -> List[str]
     """
     Return the list of available models on the model path.
@@ -48 +57 @@
 
 def isstr(s):
+    # type: (Any) -> bool
     """
     Return True if *s* is a string-like object.
@@ -55 +65 @@
     return True
 
-def load_model(model_name, **kw):
+def load_model(model_name, dtype=None, platform='ocl'):
+    # type: (str, DType, str) -> KernelModel
     """
     Load model info and build model.
+
+    *model_name* is the name of the model as used by :func:`load_model_info`.
+    Additional keyword arguments are passed directly to :func:`build_model`.
     """
-    return build_model(load_model_info(model_name), **kw)
+    return build_model(load_model_info(model_name),
+                       dtype=dtype, platform=platform)
 
 
 def load_model_info(model_name):
+    # type: (str) -> modelinfo.ModelInfo
     """
     Load a model definition given the model name.
@@ -86 +102 @@
 
 def build_model(model_info, dtype=None, platform="ocl"):
+    # type: (modelinfo.ModelInfo, DType, str) -> KernelModel
     """
     Prepare the model for the default execution platform.
@@ -138 +155 @@
 
 def precompile_dll(model_name, dtype="double"):
+    # type: (str, DType) -> Optional[str]
     """
     Precompile the dll for a model.