pyfemtet 0.6.4__tar.gz → 0.6.6__tar.gz

{pyfemtet-0.6.4 → pyfemtet-0.6.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyfemtet
-Version: 0.6.4
+Version: 0.6.6
 Summary: Design parameter optimization using Femtet.
 Home-page: https://github.com/pyfemtet/pyfemtet
 License: BSD-3-Clause
@@ -12,8 +12,10 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: brep
 Requires-Dist: babel (>=2.15.0,<3.0.0)
 Requires-Dist: botorch (==0.9.5)
+Requires-Dist: brepmatching (>=0.1.6,<0.2.0) ; extra == "brep"
 Requires-Dist: colorlog (>=6.8.0,<7.0.0)
 Requires-Dist: dash (>=2.17.0,<3.0.0)
 Requires-Dist: dash-bootstrap-components (>=1.5.0,<2.0.0)

pyfemtet-0.6.6/pyfemtet/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.6"

pyfemtet-0.6.6/pyfemtet/_util/excel_macro_util.py

@@ -0,0 +1,197 @@
+"""Excel のエラーダイアログを補足します。"""
+import sys
+from time import sleep
+from threading import Thread
+import logging
+import asyncio  # for timeout
+import win32gui
+import win32con
+import win32api
+
+logger = logging.getLogger(__name__)
+if __name__ == '__main__':
+    formatter = logging.Formatter(logging.BASIC_FORMAT)
+    handler = logging.StreamHandler(sys.stdout)
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+    logger.setLevel(logging.DEBUG)
+
+
+class _ExcelDialogProcessor:
+
+    def __init__(self, excel_, timeout):
+        self.excel = excel_
+        self.__excel_window_title = f' - Excel'  # {basename} - Excel
+        self.__error_dialog_title = 'Microsoft Visual Basic'
+        self.__vbe_window_title = f'Microsoft Visual Basic for Applications - '  # Microsoft Visual Basic for Applications - {basename}
+        self.should_stop = False
+        self.timeout = timeout
+        self.__timed_out = False
+        self.__workbook_paths = [wb.FullName for wb in excel_.Workbooks]
+        self.__error_raised = False
+        self.__excel_state_stash = dict()
+        self.__watch_thread = None
+
+    async def watch(self):
+
+        while True:
+            if self.should_stop:
+                logger.debug('エラーダイアログの監視を終了')
+                return
+            logger.debug('エラーダイアログを監視中...')
+
+            win32gui.EnumWindows(self.enum_callback_to_activate, [])
+            await asyncio.sleep(0.5)
+
+            found = []
+            win32gui.EnumWindows(self.enum_callback_to_close_dialog, found)
+            await asyncio.sleep(0.5)
+            if any(found):
+                break
+
+        logger.debug('ブックを閉じます。')
+        win32gui.EnumWindows(self.enum_callback_to_close_book, [])  # 成功していればこの時点でメイン処理では例外がスローされる
+        await asyncio.sleep(1)
+
+        logger.debug('確認ダイアログがあれば閉じます。')
+        win32gui.EnumWindows(self.enum_callback_to_close_confirm_dialog, [])
+        await asyncio.sleep(1)
+        self.__error_raised = True
+
+    def enum_callback_to_activate(self, hwnd, _):
+        title = win32gui.GetWindowText(hwnd)
+        # Excel 本体
+        if self.__excel_window_title in title:
+            # Visible == True の際、エラーが発生した際、
+            # 一度 Excel ウィンドウをアクティブ化しないと dialog が出てこない
+            # が、これだけではダメかも。
+            win32gui.PostMessage(hwnd, win32con.WM_ACTIVATE, win32con.WA_ACTIVE, 0)
+
+    def enum_callback_to_close_dialog(self, hwnd, found):
+        title = win32gui.GetWindowText(hwnd)
+        # エラーダイアログ
+        if self.__error_dialog_title == title:
+            # 何故かこのコマンド以外受け付けず、
+            # このコマンドで問答無用でデバッグモードに入る
+            logger.debug('エラーダイアログを見つけました。')
+            win32api.PostMessage(hwnd, win32con.WM_KEYDOWN, win32con.VK_RETURN, 0)
+            win32api.PostMessage(hwnd, win32con.WM_KEYUP, win32con.VK_RETURN, 0)
+            logger.debug('エラーダイアログを閉じました。')
+            found.append(True)
+
+    def enum_callback_to_close_confirm_dialog(self, hwnd, _):
+        title = win32gui.GetWindowText(hwnd)
+        # 確認ダイアログ
+        if "Microsoft Excel" in title:
+            # DisplayAlerts が False の場合は不要
+            win32gui.SendMessage(hwnd, win32con.WM_SYSCOMMAND, win32con.SC_CLOSE, 0)
+
+    def enum_callback_to_close_book(self, hwnd, _):
+        title = win32gui.GetWindowText(hwnd)
+        # VBE
+        if self.__vbe_window_title in title:
+            # 何故かこれで book 本体が閉じる
+            win32gui.SendMessage(hwnd, win32con.WM_CLOSE, 0, 0)
+
+    async def watch_main(self):
+        try:
+            await asyncio.wait_for(self.watch(), timeout=self.timeout)
+        except asyncio.TimeoutError:
+            logger.debug('タイムアウトしました。')
+            self.should_stop = True
+            self.__timed_out = True
+
+    def __enter__(self):
+        logger.debug('Excel を 不可視にします。')
+        self.__excel_state_stash['visible'] = self.excel.Visible
+        self.__excel_state_stash['display_alerts'] = self.excel.DisplayAlerts
+        self.excel.Visible = False
+        self.excel.DisplayAlerts = False
+
+        logger.debug('エラー監視を開始します。')
+        self.__watch_thread = Thread(
+            target=asyncio.run,
+            args=(self.watch_main(),),
+        )
+        self.__watch_thread.start()
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+
+        logger.debug('Excel の状態を回復します。')
+
+        self.should_stop = True
+        self.__watch_thread.join()
+
+        self.excel.Visible = self.__excel_state_stash['visible']
+        self.excel.DisplayAlerts = self.__excel_state_stash['display_alerts']
+
+        if self.__timed_out:
+            logger.debug('Excel プロセスを強制終了します。')
+            logger.error('Excel プロセス強制終了は未実装です。')
+            raise TimeoutError('マクロの実行がタイムアウトしました。')
+
+        # if exc_type is not None:
+        #     if issubclass(exc_type, com_error) and self.__error_raised:
+        if self.__error_raised:
+                logger.debug('エラーハンドリングの副作用でブックを閉じているので'
+                             'Excel のブックを開きなおします。')
+                for wb_path in self.__workbook_paths:
+                    self.excel.Workbooks.Open(wb_path)
+
+
+def watch_excel_macro_error(excel_, timeout):
+    """Excel のエラーダイアログの出現を監視し、検出されればブックを閉じます。"""
+    return _ExcelDialogProcessor(excel_, timeout)
+
+
+if __name__ == '__main__':
+
+    import os
+    os.chdir(os.path.dirname(__file__))
+
+    path = os.path.abspath('sample.xlsm')
+    path2 = os.path.abspath('sample2.xlsm')
+
+
+    from win32com.client import Dispatch
+    from pythoncom import com_error
+
+    logger.debug('Excel を起動しています。')
+    excel = Dispatch('Excel.Application')
+    excel.Visible = True
+    excel.DisplayAlerts = False
+    excel.Interactive = True
+
+    logger.debug('Workbook を開いています。')
+    excel.Workbooks.Open(path)
+
+    logger.debug('別の Workbook を開いています。')
+    excel.Workbooks.Open(path2)
+
+    logger.debug('Workbook に変更を加えます。')
+    excel.Workbooks(1).ActiveSheet.Range('A1').Value = 1.
+
+    logger.debug('開いている Workbooks 数：')
+    logger.debug(excel.Workbooks.Count)
+
+    try:
+        with watch_excel_macro_error(excel, timeout=10):
+            sleep(3)
+            try:
+                excel.Run('raise_error')
+            except com_error as e:
+                logger.debug('この段階ではまだ Excel 回復機能が働きません。')
+                logger.debug('開いている Workbooks 数：')
+                logger.debug(excel.Workbooks.Count)
+                raise e
+
+            # excel.Run('no_error')
+
+    except com_error as e:
+        logger.debug('メイン処理でエラーを補足しました。：')
+        logger.debug(e)
+
+    logger.debug('開いている Workbooks 数：')
+    logger.debug(excel.Workbooks.Count)
+
+    logger.debug('保存していない場合、Workbook の変更は失われます。')

{pyfemtet-0.6.4 → pyfemtet-0.6.6}/pyfemtet/_warning.py

@@ -2,15 +2,19 @@ import warnings
 from functools import wraps
 
 
+def show_experimental_warning(feature_name):
+    warnings.warn(
+        f"The function '{feature_name}' is experimental and may change in the future.",
+        category=UserWarning,
+        stacklevel=2
+    )
+
+
 def experimental_feature(func):
 
     @wraps(func)
     def wrapper(*args, **kwargs):
-        warnings.warn(
-            f"The function '{func.__name__}' is experimental and may change in the future.",
-            category=UserWarning,
-            stacklevel=2
-        )
+        show_experimental_warning(func.__name__)
         return func(*args, **kwargs)
 
     return wrapper
@@ -62,6 +66,10 @@ if __name__ == '__main__':
         print("This is an experimental function.")
 
     class Sample:
+
+        def __init__(self):
+            show_experimental_warning("Sample")
+
         @experimental_feature
         def add(self, a, b):
             return a + b

pyfemtet-0.6.6/pyfemtet/brep/__init__.py

@@ -0,0 +1,3 @@
+from pyfemtet.brep._impl import ModelUpdater
+
+__all__ = ['ModelUpdater']

pyfemtet-0.6.6/pyfemtet/brep/_impl.py

@@ -0,0 +1,14 @@
+try:
+    import brepmatching
+except ModuleNotFoundError as e:
+    import warnings
+    warnings.warn(
+        'There is no installation of `brepmatching`. '
+        'Please confirm installation via '
+        '`pip install pyfemtet[brep]` or '
+        '`pip install brepmatching` command.'
+    )
+    raise e
+
+from brepmatching.pyfemtet_scripts.replace_model_considering_their_matching import ModelUpdater
+

{pyfemtet-0.6.4 → pyfemtet-0.6.6}/pyfemtet/opt/interface/_excel_interface.py

@@ -25,7 +25,9 @@ from pyfemtet.dispatch_extensions._impl import _NestableSpawnProcess
 from pyfemtet._femtet_config_util.exit import _exit_or_force_terminate
 from pyfemtet._femtet_config_util.autosave import _set_autosave_enabled, _get_autosave_enabled
 
-from pyfemtet._warning import experimental_class
+from pyfemtet._util.excel_macro_util import watch_excel_macro_error
+
+from pyfemtet._warning import show_experimental_warning
 
 import logging
 
@@ -33,7 +35,6 @@ logger = logging.getLogger(__name__)
 logger.setLevel(logging.INFO)
 
 
-@experimental_class
 class ExcelInterface(FEMInterface):
 
     input_xlsm_path: Path  # 操作対象の xlsm パス
@@ -52,8 +53,8 @@ class ExcelInterface(FEMInterface):
     wb_output: CDispatch  # システムを構成する Workbook
     sh_output: CDispatch  # 計算結果の定義された WorkSheet (sh_input と同じでもよい)
 
-    visible: bool = True  # excel を可視化するかどうか
-    display_alerts: bool = True  # ダイアログを表示するかどうか
+    visible: bool = False  # excel を可視化するかどうか
+    display_alerts: bool = False  # ダイアログを表示するかどうか
 
     _load_problem_from_me: bool = True  # TODO: add_parameter() 等を省略するかどうか。定義するだけでフラグとして機能する。
     _excel_pid: int
@@ -69,7 +70,9 @@ class ExcelInterface(FEMInterface):
             procedure_name: str = None,
             procedure_args: list or tuple = None,
             connect_method: str = 'auto',  # or 'new'
+            procedure_timeout: float or None = None,
     ):
+        show_experimental_warning("ExcelInterface")
 
         # 初期化
         self.input_xlsm_path = None  # あとで取得する
@@ -81,6 +84,7 @@ class ExcelInterface(FEMInterface):
         assert connect_method in ['new', 'auto']
         self.connect_method = connect_method
         self._femtet_autosave_buffer = _get_autosave_enabled()
+        self.procedure_timeout = procedure_timeout
 
         # dask サブプロセスのときは space 直下の input_xlsm_path を参照する
         try:
@@ -119,8 +123,9 @@ class ExcelInterface(FEMInterface):
             procedure_name=self.procedure_name,
             procedure_args=self.procedure_args,
             connect_method='new',  # subprocess で connect する際は new を強制する
+            procedure_timeout=self.procedure_timeout,
         )
-        super().__init__(**kwargs)
+        FEMInterface.__init__(self, **kwargs)
 
     def __del__(self):
         try:
@@ -256,20 +261,18 @@ class ExcelInterface(FEMInterface):
 
         # マクロ実行
         try:
-            self.excel.Run(
-                f'{self.wb_input.Name}!{self.procedure_name}',
-                *self.procedure_args
-            )
+            with watch_excel_macro_error(self.excel, timeout=self.procedure_timeout):
+                self.excel.Run(
+                    f'{self.procedure_name}',
+                    *self.procedure_args
+                )
 
-        # FIXME: エラーハンドリング
-        #   com_error をキャッチする(solveerror)か、
-        #   sh_out に解析結果を書く(拘束違反)ようにして、
-        #   それが FALSE なら SolveError を raise する。
-        except ...:
-            raise SolveError('Excelアップデートに失敗しました')
+            # 再計算
+            self.excel.CalculateFull()
+
+        except com_error as e:
+            raise SolveError(f'Failed to run macro {self.procedure_name}. The original message is: {e}')
 
-        # 再計算
-        self.excel.CalculateFull()
 
     def quit(self):
         logger.info('Excel-Femtet の終了処理を開始します。')  # FIXME: message にする
@@ -290,7 +293,7 @@ class ExcelInterface(FEMInterface):
         gc.collect()
 
         # quit した後ならば femtet を終了できる
-        # excel の process の完全消滅を待つ
+        # excel の process の消滅を待つ
         logger.info('Excel の終了を待っています。')
         while self._excel_pid == _get_pid(self._excel_hwnd):
             sleep(1)
@@ -298,12 +301,14 @@ class ExcelInterface(FEMInterface):
         # 正確だが時間がかかるかも
         logger.info('終了する Femtet を特定しています。')
         femtet_pid = util.get_last_executed_femtet_process_id()
-        Femtet, caught_pid = dispatch_specific_femtet(femtet_pid)
-        _exit_or_force_terminate(timeout=3, Femtet=Femtet, force=True)
+        from multiprocessing import Process
+        p = Process(target=_terminate_femtet, args=(femtet_pid,))
+        p.start()
 
         logger.info('自動保存機能の設定を元に戻しています。')
         _set_autosave_enabled(self._femtet_autosave_buffer)
 
+        p.join()
         logger.info('Excel-Femtet を終了しました。')
 
     # 直接アクセスしてもよいが、ユーザーに易しい名前にするためだけのプロパティ
@@ -422,6 +427,11 @@ def wait_femtet():
         Femtet = Dispatch('FemtetMacro.Femtet')
 
 
+def _terminate_femtet(femtet_pid_):
+    CoInitialize()
+    Femtet, caught_pid = dispatch_specific_femtet(femtet_pid_)
+    _exit_or_force_terminate(timeout=3, Femtet=Femtet, force=True)
+
 # main thread で作成した excel への参照を含む関数を
 # 直接 thread や process に渡すと機能しない
 class ScapeGoatObjective: