pyfemtet 0.6.5__tar.gz → 0.7.0__tar.gz

{pyfemtet-0.6.5 → pyfemtet-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyfemtet
-Version: 0.6.5
+Version: 0.7.0
 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.7.0/pyfemtet/__init__.py

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

{pyfemtet-0.6.5 → pyfemtet-0.7.0}/pyfemtet/_femtet_config_util/exit.py

@@ -1,5 +1,4 @@
 from time import time, sleep
-import logging
 
 from win32com.client import CDispatch
 from femtetutils import util
@@ -9,7 +8,9 @@ from pyfemtet.dispatch_extensions._impl import _get_pid
 from pyfemtet.core import _version
 from pyfemtet._message import Msg
 
-logger = logging.getLogger('fem')
+from pyfemtet.logger import get_module_logger
+
+logger = get_module_logger('util.femtet.exit', __name__)
 
 
 def _exit_or_force_terminate(timeout, Femtet: CDispatch, force=True):

{pyfemtet-0.6.5 → pyfemtet-0.7.0}/pyfemtet/_util/excel_macro_util.py

@@ -1,25 +1,19 @@
 """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)
+from pyfemtet.logger import get_module_logger
+
+logger = get_module_logger('util.excel', __name__)
 
 
 class _ExcelDialogProcessor:
 
-    def __init__(self, excel_, timeout):
+    def __init__(self, excel_, timeout, restore_book=True):
         self.excel = excel_
         self.__excel_window_title = f' - Excel'  # {basename} - Excel
         self.__error_dialog_title = 'Microsoft Visual Basic'
@@ -31,6 +25,7 @@ class _ExcelDialogProcessor:
         self.__error_raised = False
         self.__excel_state_stash = dict()
         self.__watch_thread = None
+        self.restore_book = restore_book
 
     async def watch(self):
 
@@ -133,15 +128,17 @@ class _ExcelDialogProcessor:
         # if exc_type is not None:
         #     if issubclass(exc_type, com_error) and self.__error_raised:
         if self.__error_raised:
+            if self.restore_book:
                 logger.debug('エラーハンドリングの副作用でブックを閉じているので'
                              'Excel のブックを開きなおします。')
                 for wb_path in self.__workbook_paths:
                     self.excel.Workbooks.Open(wb_path)
 
 
-def watch_excel_macro_error(excel_, timeout):
+def watch_excel_macro_error(excel_, timeout, restore_book=True):
     """Excel のエラーダイアログの出現を監視し、検出されればブックを閉じます。"""
-    return _ExcelDialogProcessor(excel_, timeout)
+    return _ExcelDialogProcessor(excel_, timeout, restore_book)
+
 
 
 if __name__ == '__main__':

pyfemtet-0.7.0/pyfemtet/brep/__init__.py

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

pyfemtet-0.7.0/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.5 → pyfemtet-0.7.0}/pyfemtet/dispatch_extensions/__init__.py

@@ -9,4 +9,3 @@ from pyfemtet.dispatch_extensions._impl import (
     _get_pid,
     _get_pids,
 )
-

{pyfemtet-0.6.5 → pyfemtet-0.7.0}/pyfemtet/dispatch_extensions/_impl.py

@@ -18,14 +18,11 @@ from multiprocessing.context import BaseContext, SpawnProcess, _concrete_context
 from multiprocessing.process import _children, _cleanup
 from multiprocessing.managers import SyncManager
 
-import logging
-from pyfemtet.logger import get_logger
-
 from pyfemtet._message import Msg
 
+from pyfemtet.logger import get_module_logger
 
-logger = get_logger('dispatch')
-logger.setLevel(logging.INFO)
+logger = get_module_logger('dispatch', __name__)
 
 
 DISPATCH_TIMEOUT = 120

pyfemtet-0.7.0/pyfemtet/logger/__init__.py

@@ -0,0 +1,22 @@
+import logging
+from pyfemtet.logger._impl import (
+    get_module_logger,
+    add_file_output,
+    set_stdout_output,
+    remove_file_output,
+    remove_stdout_output,
+    remove_all_output,
+)
+
+
+def get_dask_logger():
+    return logging.getLogger('distributed')
+
+
+def get_optuna_logger():
+    import optuna
+    return optuna.logging.get_logger('optuna')
+
+
+def get_dash_logger():
+    return logging.getLogger('werkzeug')

pyfemtet-0.7.0/pyfemtet/logger/_impl.py

@@ -0,0 +1,231 @@
+import logging
+import os
+import sys
+import datetime
+import locale
+from threading import Lock
+from pathlib import Path
+import platform
+
+from colorlog import ColoredFormatter
+from dask.distributed import get_worker
+
+LOCALE, LOCALE_ENCODING = locale.getlocale()
+if platform.system() == 'Windows':
+    DATEFMT = '%#m/%#d %#H:%M'
+else:
+    DATEFMT = '%-m/%-d %-H:%M'
+
+__lock = Lock()  # thread 並列されたタスクがアクセスする場合に備えて
+
+__initialized_root_packages: list[str] = list()
+
+
+# ===== set dask worker prefix to ``ROOT`` logger =====
+
+def _get_dask_worker_name():
+    name = '(Main)'
+    try:
+        worker = get_worker()
+        if isinstance(worker.name, str):  # local なら index, cluster なら tcp address
+            name = f'({worker.name})'
+        else:
+            name = f'(Sub{worker.name})'
+    except ValueError:
+        pass
+    return name
+
+
+class _DaskLogRecord(logging.LogRecord):
+    def getMessage(self):
+        msg = str(self.msg)
+        if self.args:
+            msg = msg % self.args
+        msg = _get_dask_worker_name() + ' ' + msg
+        return msg
+
+
+logging.setLogRecordFactory(_DaskLogRecord)
+
+
+# ===== format config =====
+
+def __create_formatter(colored=True):
+
+    if colored:
+        # colorized
+        header = "%(log_color)s" + "[%(name)s %(levelname).4s]" + " %(asctime)s" + "%(reset)s"
+
+        formatter = ColoredFormatter(
+            f"{header} %(message)s",
+            datefmt=DATEFMT,
+            reset=True,
+            log_colors={
+                "DEBUG": "purple",
+                "INFO": "cyan",
+                "WARNING": "yellow",
+                "ERROR": "light_red",
+                "CRITICAL": "red",
+            },
+        )
+
+    else:
+        header = "[%(name)s %(levelname).4s]"
+        formatter = logging.Formatter(
+            f"{header} %(message)s",
+            datefmt=DATEFMT,
+        )
+
+    return formatter
+
+
+# ===== handler config =====
+
+STDOUT_HANDLER_NAME = 'stdout-handler'
+
+
+def __get_stdout_handler():
+    stdout_handler = logging.StreamHandler(sys.stdout)
+    stdout_handler.set_name(STDOUT_HANDLER_NAME)
+    stdout_handler.setFormatter(__create_formatter(colored=True))
+    return stdout_handler
+
+
+def __has_stdout_handler(logger):
+    return any([handler.get_name() != STDOUT_HANDLER_NAME for handler in logger.handlers])
+
+
+def set_stdout_output(logger, level=logging.INFO):
+
+    if not __has_stdout_handler(logger):
+        logger.addHandler(__get_stdout_handler())
+
+    logger.setLevel(level)
+
+
+def remove_stdout_output(logger):
+    if __has_stdout_handler(logger):
+        logger.removeHandler(__get_stdout_handler())
+
+
+def add_file_output(logger, filepath=None, level=logging.INFO) -> str:
+    """Add FileHandler to the logger.
+
+    Returns:
+        str: THe name of the added handler.
+        Its format is 'filehandler-{os.path.basename(filepath)}'
+
+    """
+
+    # certify filepath
+    if filepath is None:
+        filepath = datetime.datetime.now().strftime('%Y%m%d-%H%M%S') + f'_{logger.name}.log'
+
+    # add file handler
+    file_handler = logging.FileHandler(filename=filepath, encoding=LOCALE_ENCODING)
+    file_handler.set_name(f'filehandler-{os.path.basename(filepath)}')
+    file_handler.setFormatter(__create_formatter(colored=False))
+    logger.addHandler(file_handler)
+
+    # set (default) log level
+    logger.setLevel(level)
+
+    return file_handler.get_name()
+
+
+def remove_file_output(logger, filepath=None):
+    """Removes FileHandler from the logger.
+
+    If filepath is None, remove all FileHandler.
+    """
+
+    if filepath is None:
+        for handler in logger.handlers:
+            if 'filehandler-' in handler.name:
+                logger.removeHandler(handler)
+
+    else:
+        handler_name = f'filehandler-{os.path.basename(filepath)}'
+        for handler in logger.handlers:
+            if handler_name == handler.name:
+                logger.removeHandler(handler)
+
+
+def remove_all_output(logger):
+    for handler in logger.handlers:
+        logger.removeHandler(handler)
+
+    logger.addHandler(logging.NullHandler())
+
+
+# ===== root-package logger =====
+
+def setup_package_root_logger(package_name):
+    global __initialized_root_packages
+    if package_name not in __initialized_root_packages:
+        with __lock:
+            logger = logging.getLogger(package_name)
+            logger.propagate = True
+            set_stdout_output(logger)
+            logger.setLevel(logging.INFO)
+            __initialized_root_packages.append(package_name)
+    else:
+        logger = logging.getLogger(package_name)
+    return logger
+
+
+# ===== module logger =====
+
+def get_module_logger(name: str, __module_name__: str, ) -> logging.Logger:
+    """Return the module-level logger.
+
+    The format is defined in the package_root_logger.
+
+    Args:
+        name (str): The logger name to want.
+        __module_name__ (str): __name__ of the module.
+
+    Returns:
+        logging.Logger:
+            The logger its name is ``root_package.subpackage.module``.
+            child level logger's signal propagates to the parent logger
+            and is shown in the parent(s)'s handler(s).
+
+    """
+
+    # check root logger initialized
+    name_arr = name.split('.')
+    if name_arr[0] not in __initialized_root_packages:
+        setup_package_root_logger(name_arr[0])
+
+    # get logger
+    logger = logging.getLogger(name)
+
+    # If not root logger, ensure propagate is True.
+    if len(name_arr) > 1:
+        logger.propagate = True
+
+    # If debug mode, set specific level.
+    if __module_name__ == '__main__':
+        logger.setLevel(logging.DEBUG)
+
+    return logger
+
+
+if __name__ == '__main__':
+
+    root_logger = setup_package_root_logger('logger')
+    optimizer_logger = get_module_logger('logger.optimizer', __name__); optimizer_logger.setLevel(logging.INFO)
+    interface_logger = get_module_logger('logger.interface', __name__)
+
+    root_logger.info("This is root logger's info.")
+    optimizer_logger.info("This is optimizer logger's info.")
+
+    add_file_output(interface_logger, 'test-module-log.log', level=logging.DEBUG)
+    interface_logger.debug('debugging...')
+    remove_file_output(interface_logger, 'test-module-log.log')
+
+    interface_logger.debug('debug is finished.')
+    root_logger.debug("This message will not be shown "
+                      "even if the module_logger's level "
+                      "is logging.DEBUG.")

{pyfemtet-0.6.5 → pyfemtet-0.7.0}/pyfemtet/opt/_femopt_core.py

@@ -22,7 +22,7 @@ if version.parse(optuna.version.__version__) < version.parse('4.0.0'):
 else:
     from optuna._hypervolume import wfg
     compute_hypervolume = wfg.compute_hypervolume
-from dask.distributed import Lock, get_client
+from dask.distributed import Lock, get_client, Client
 
 # win32com
 from win32com.client import constants, Constants
@@ -32,10 +32,9 @@ from pyfemtet.opt.interface import FEMInterface, FemtetInterface
 from pyfemtet._message import encoding, Msg
 
 # logger
-import logging
-from pyfemtet.logger import get_logger
-logger = get_logger('femopt')
-logger.setLevel(logging.INFO)
+from pyfemtet.logger import get_module_logger
+
+logger = get_module_logger('opt.core', __name__)
 
 
 __all__ = [
@@ -503,19 +502,6 @@ class ObjectivesFunc:
         return f
 
 
-class _HistoryDfCore:
-    """Class for managing a DataFrame object in a distributed manner."""
-
-    def __init__(self):
-        self.df = pd.DataFrame()
-
-    def set_df(self, df):
-        self.df = df
-
-    def get_df(self):
-        return self.df
-
-
 class History:
     """Class for managing the history of optimization results.
 
@@ -543,8 +529,6 @@ class History:
     is_restart = False
     is_processing = False
     _df = None  # in case without client
-    _future = None  # in case with client
-    _actor_data = None  # in case with client
 
     def __init__(
             self,
@@ -565,6 +549,7 @@ class History:
         self.obj_names = obj_names
         self.cns_names = cns_names
         self.additional_metadata = additional_metadata or ''
+        self.__scheduler_address = client.scheduler.address if client is not None else None
 
         # 最適化実行中かどうか
         self.is_processing = client is not None
@@ -572,10 +557,6 @@ class History:
         # 最適化実行中の process monitor である場合
         if self.is_processing:
 
-            # actor の生成
-            self._future = client.submit(_HistoryDfCore, actor=True)
-            self._actor_data = self._future.result()
-
             # csv が存在すれば続きからモード
             self.is_restart = os.path.isfile(self.path)
 
@@ -641,16 +622,36 @@ class History:
         self.set_df(df)
 
     def get_df(self) -> pd.DataFrame:
-        if self._actor_data is None:
+        if self.__scheduler_address is None:
             return self._df
         else:
-            return self._actor_data.get_df().result()
+            # scheduler がまだ存命か確認する
+            try:
+                with Lock('access-df'):
+                    client_: 'Client' = get_client(self.__scheduler_address)
+                    if 'df' in client_.list_datasets():
+                        return client_.get_dataset('df')
+                    else:
+                        logger.debug('Access df of History before it is initialized.')
+                        return pd.DataFrame()
+            except OSError:
+                logger.error('Scheduler is already dead. Most frequent reasen to show this message is that the pyfemtet monitor UI is not refreshed even if the main optimization process is terminated.')
+                return pd.DataFrame()
 
     def set_df(self, df: pd.DataFrame):
-        if self._actor_data is None:
+        if self.__scheduler_address is None:
             self._df = df
         else:
-            self._actor_data.set_df(df).result()
+            try:
+                with Lock('access-df'):
+                    client_: 'Client' = get_client(self.__scheduler_address)
+                    if 'df' in client_.list_datasets():
+                        client_.unpublish_dataset('df')  # 更新する場合は前もって削除が必要、本来は dask collection をここに入れる使い方をする。
+                    client_.publish_dataset(**dict(
+                        df=df
+                    ))
+            except OSError:
+                logger.error('Scheduler is already dead. Most frequent reasen to show this message is that the pyfemtet monitor UI is not refreshed even if the main optimization process is terminated.')
 
     def create_df_columns(self):
         """Create columns of history."""

{pyfemtet-0.6.5 → pyfemtet-0.7.0}/pyfemtet/opt/_test_utils/control_femtet.py

@@ -5,12 +5,6 @@ from tqdm import tqdm
 from win32com.client import Dispatch
 from femtetutils import util
 
-import logging
-
-
-logger = logging.getLogger("test")
-logger.setLevel(logging.DEBUG)
-
 
 def _open_femprj(femprj_path):
     Femtet = Dispatch("FemtetMacro.Femtet")

{pyfemtet-0.6.5 → pyfemtet-0.7.0}/pyfemtet/opt/interface/__init__.py

@@ -1,4 +1,4 @@
-from pyfemtet.opt.interface._base import FEMInterface, logger
+from pyfemtet.opt.interface._base import FEMInterface
 from pyfemtet.opt.interface._base import NoFEM
 from pyfemtet.opt.interface._femtet import FemtetInterface
 from pyfemtet.opt.interface._femtet_with_sldworks import FemtetWithSolidworksInterface

{pyfemtet-0.6.5 → pyfemtet-0.7.0}/pyfemtet/opt/interface/_base.py

@@ -5,11 +5,9 @@ from abc import ABC, abstractmethod
 
 import pandas as pd
 
-import logging
-from pyfemtet.logger import get_logger
-logger = get_logger('FEM')
-logger.setLevel(logging.INFO)
+from pyfemtet.logger import get_module_logger
 
+logger = get_module_logger('opt.interface', __name__)
 
 here, me = os.path.split(__file__)