`Settings`#

class pyedb.generic.settings.Settings#

Bases: object

Manages all PyEDB environment variables and global settings.

Overview#

Properties

`retry_n_times_time_interval`	Time interval between the retries by the `_retry_n_times` method.
`is_grpc`	Whether Edb is launched using grpc or not.
`is_in_memory`	Whether Edb is launched using memory or not. sed only with gRPC. When True by pass connection socket.
`edb_environment_variables`	Environment variables that are set before launching a new AEDT session,
`aedt_version`	AEDT version in the form `"2023.x"`. In AEDT 2022 R2 and later,
`global_log_file_size`	Global PyEDB log file size in MB. The default value is `10`.
`enable_global_log_file`	Flag for enabling and disabling the global PyEDB log file located in the global temp folder.
`enable_local_log_file`	Flag for enabling and disabling the local PyEDB log file located
`global_log_file_name`	Global PyEDB log file path. The default is `pyedb_username.log`.
`enable_debug_methods_argument_logger`	Flag for whether to write out the method’s arguments in the debug logger.
`enable_error_handler`	Flag for enabling and disabling the internal PyEDB error handling.
`enable_file_logs`	Flag for enabling and disabling the logging to a file.
`enable_logger`	Flag for enabling and disabling the logging overall.
`logger_file_path`	PyEDB log file path.
`logger_formatter`	Message format of the log entries.
`logger_datefmt`	Date format of the log entries.
`enable_debug_edb_logger`	Flag for enabling and disabling the logger for any EDB API methods.
`enable_debug_internal_methods_logger`	Flag for enabling and disabling the logging for internal methods.
`enable_debug_logger`	Flag for enabling and disabling the debug level logger.
`enable_screen_logs`	Flag for enabling and disabling the logging to STDOUT.
`edb_dll_path`	Optional path for the EDB DLL file.
`aedt_installation_path`

Attributes

`CURRENT_STABLE_AEDT_VERSION`
`INSTALLED_VERSIONS`
`INSTALLED_STUDENT_VERSIONS`
`INSTALLED_CLIENT_VERSIONS`
`LATEST_VERSION`
`LATEST_STUDENT_VERSION`
`specified_version`
`is_student_version`
`remote_rpc_session`
`pyedb_server_path`
`formatter`
`time_tick`
`logger`
`log_file`

Import detail#

from pyedb.generic.settings import Settings

Property detail#

property Settings.retry_n_times_time_interval#: Time interval between the retries by the _retry_n_times method.

property Settings.is_grpc#

Whether Edb is launched using grpc or not.

Returns:

bool

property Settings.is_in_memory#

Whether Edb is launched using memory or not. sed only with gRPC. When True by pass connection socket. Designed to be used when client and RPC server are both running locally. Performances are expected to be better.

Returns:

bool

property Settings.edb_environment_variables#: Environment variables that are set before launching a new AEDT session, including those that enable the beta features.

property Settings.aedt_version#: AEDT version in the form "2023.x". In AEDT 2022 R2 and later, evaluating a bounding box by exporting a SAT file is disabled.

property Settings.global_log_file_size#: Global PyEDB log file size in MB. The default value is 10.

property Settings.enable_global_log_file#: Flag for enabling and disabling the global PyEDB log file located in the global temp folder. The default is True.

property Settings.enable_local_log_file#: Flag for enabling and disabling the local PyEDB log file located in the projectname.pyedb project folder. The default is True.

property Settings.global_log_file_name#: Global PyEDB log file path. The default is pyedb_username.log.

property Settings.enable_debug_methods_argument_logger#: Flag for whether to write out the method’s arguments in the debug logger. The default is False.

property Settings.enable_error_handler#: Flag for enabling and disabling the internal PyEDB error handling.

property Settings.enable_file_logs#: Flag for enabling and disabling the logging to a file.

property Settings.enable_logger#: Flag for enabling and disabling the logging overall.

property Settings.logger_file_path#: PyEDB log file path.

property Settings.logger_formatter#: Message format of the log entries. The default is '%(asctime)s:%(destination)s:%(extra)s%(levelname)-8s:%(message)s'

property Settings.logger_datefmt#: Date format of the log entries. The default is '%Y/%m/%d %H.%M.%S'

property Settings.enable_debug_edb_logger#: Flag for enabling and disabling the logger for any EDB API methods.

property Settings.enable_debug_internal_methods_logger#: Flag for enabling and disabling the logging for internal methods. This setting is useful for debug purposes.

property Settings.enable_debug_logger#: Flag for enabling and disabling the debug level logger.

property Settings.enable_screen_logs#: Flag for enabling and disabling the logging to STDOUT.

property Settings.edb_dll_path#: Optional path for the EDB DLL file.

property Settings.aedt_installation_path#

Attribute detail#

Settings.CURRENT_STABLE_AEDT_VERSION = 2026.1#

Settings.INSTALLED_VERSIONS = None#

Settings.INSTALLED_STUDENT_VERSIONS = None#

Settings.INSTALLED_CLIENT_VERSIONS = None#

Settings.LATEST_VERSION = None#

Settings.LATEST_STUDENT_VERSION = None#

Settings.specified_version = None#

Settings.is_student_version = False#

Settings.remote_rpc_session = False#

Settings.pyedb_server_path = ''#

Settings.formatter = None#

Settings.time_tick#

Settings.logger = None#

Settings.log_file = None#