DSS_EXTENSIONS_DEBUG: Implement support for loading the debug version of the library. A new CFFI module is built for it.

Author: PMeira

dss/_cffi_api_util.py

@@ -78,7 +78,7 @@ def CheckForError(self, result=None):
         if self._errorPtr[0]:
             error_num = self._errorPtr[0]
             self._errorPtr[0] = 0
-            raise DssException(error_num, self._get_string(self._lib.Error_Get_Description()))
+            raise DSSException(error_num, self._get_string(self._lib.Error_Get_Description()))
 
         return result
 

dss/v7.py

@@ -3,7 +3,14 @@
 '''
 
 from __future__ import absolute_import
-from ._dss_capi_v7 import ffi, lib
+import os
+if os.environ.get('DSS_EXTENSIONS_DEBUG', '') != '1':
+    from ._dss_capi_v7 import ffi, lib
+else:
+    import warnings
+    warnings.warn('Environment variable DSS_EXTENSIONS_DEBUG=1 is set, loading the debug version of DSS C-API')
+    from ._dss_capi_v7d import ffi, lib
+
 from ._cffi_api_util import CffiApiUtil, use_com_compat, DssException
 from . import dss_capi_gr, dss_capi_ir, enums
 from .enums import *

dss/v8.py

@@ -1,6 +1,3 @@
-'''
-This module used to present an instance for the OpenDSS Version 8 implementation. It was based on the official parallel-machine version, which allow creating multiple solvers (actors) in a single process. The mechanism is being reword in DSS C-API, the library used by DSS_Python to implement OpenDSS, to reproduce a stable version in the future.
-'''
 from __future__ import absolute_import
 from .v7 import *
 import warnings

dss_build.py

@@ -74,10 +74,12 @@ def process_header(src, extern_py=False, implement_py=False, prefix=''):
 src_path = os.environ.get('SRC_DIR', '')
 DSS_CAPI_PATH = os.environ.get('DSS_CAPI_PATH', os.path.join(src_path, '..', 'dss_capi'))
 
-for version in DSS_VERSIONS:    
+for version in DSS_VERSIONS:
     ffi_builder_dss = FFI()
 
-    with open(os.path.join(DSS_CAPI_PATH, 'include', version, 'dss_capi.h'), 'r') as f:
+    base_version = version.rstrip('d')
+
+    with open(os.path.join(DSS_CAPI_PATH, 'include', base_version, 'dss_capi.h'), 'r') as f:
         cffi_header_dss = process_header(f.read())
 
     with open('cffi/dss_capi_custom.h', 'r') as f:
@@ -93,10 +95,10 @@ def process_header(src, extern_py=False, implement_py=False, prefix=''):
     ffi_builder_dss.set_source("_dss_capi_{}".format(version), extra_source_dss,
         libraries=["dss_capi_{}".format(version)],
         library_dirs=[
-            os.path.join(DSS_CAPI_PATH, 'lib/{}/{}'.format(PLATFORM_FOLDER, version)), 
+            os.path.join(DSS_CAPI_PATH, 'lib/{}/{}'.format(PLATFORM_FOLDER, base_version)), 
             os.path.join(DSS_CAPI_PATH, 'lib/{}'.format(PLATFORM_FOLDER))
         ],
-        include_dirs=[os.path.join(DSS_CAPI_PATH, 'include/{}'.format(version))],
+        include_dirs=[os.path.join(DSS_CAPI_PATH, 'include/{}'.format(base_version))],
         source_extension='.c',
         **extra
     )
@@ -143,6 +145,7 @@ def process_header(src, extern_py=False, implement_py=False, prefix=''):
 # Is there a better way to do this? Unfortunately setup(cffi_modules=...)
 # needs a list of strings and cannot handle objects directly
 ffi_builder_v7 = ffi_builders['v7']
+ffi_builder_v7d = ffi_builders['v7d']
 # ffi_builder_v8 = ffi_builders['v8']
 ffi_builder_GenUserModel = ffi_builders['GenUserModel']
 ffi_builder_PVSystemUserModel = ffi_builders['PVSystemUserModel']

dss_setup_common.py

@@ -5,7 +5,7 @@
 platform_short = ''.join(filter(lambda ch: ch.isalpha(), sys.platform))
 PLATFORM_FOLDER = '{}_{}'.format(platform_short, arch)
 
-DSS_VERSIONS = ('v7', )
+DSS_VERSIONS = ('v7', 'v7d')
 
 if sys.platform == 'win32':
     DLL_SUFFIX = '.dll'