Merge branch 'main' into Remove-the-use-of-deprecated-tranport-method…

…s-in-tests
aiidateam · Nov 28, 2024 · e1f0b22 · e1f0b22
2 parents aae9525 + 9baf3ca
commit e1f0b22
Show file tree

Hide file tree

Showing 22 changed files with 257 additions and 128 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -125,7 +125,6 @@ repos:
         src/aiida/engine/processes/ports.py|
         src/aiida/manage/configuration/__init__.py|
         src/aiida/manage/configuration/config.py|
-        src/aiida/manage/configuration/profile.py|
         src/aiida/manage/external/rmq/launcher.py|
         src/aiida/manage/tests/main.py|
         src/aiida/manage/tests/pytest_fixtures.py|

diff --git a/src/aiida/cmdline/commands/cmd_presto.py b/src/aiida/cmdline/commands/cmd_presto.py
@@ -67,7 +67,7 @@ def detect_postgres_config(
     """
     import secrets
 
-    from aiida.manage.configuration.settings import AIIDA_CONFIG_FOLDER
+    from aiida.manage.configuration.settings import AiiDAConfigDir
     from aiida.manage.external.postgres import Postgres
 
     dbinfo = {
@@ -92,13 +92,15 @@ def detect_postgres_config(
     except Exception as exception:
         raise ConnectionError(f'Unable to automatically create the PostgreSQL user and database: {exception}')
 
+    aiida_config_folder = AiiDAConfigDir.get()
+
     return {
         'database_hostname': postgres_hostname,
         'database_port': postgres_port,
         'database_name': database_name,
         'database_username': database_username,
         'database_password': database_password,
-        'repository_uri': f'file://{AIIDA_CONFIG_FOLDER / "repository" / profile_name}',
+        'repository_uri': f'file://{aiida_config_folder / "repository" / profile_name}',
     }
 
 

diff --git a/src/aiida/cmdline/commands/cmd_profile.py b/src/aiida/cmdline/commands/cmd_profile.py
@@ -169,9 +169,9 @@ def profile_list():
         # This can happen for a fresh install and the `verdi setup` has not yet been run. In this case it is still nice
         # to be able to see the configuration directory, for instance for those who have set `AIIDA_PATH`. This way
         # they can at least verify that it is correctly set.
-        from aiida.manage.configuration.settings import AIIDA_CONFIG_FOLDER
+        from aiida.manage.configuration.settings import AiiDAConfigDir
 
-        echo.echo_report(f'configuration folder: {AIIDA_CONFIG_FOLDER}')
+        echo.echo_report(f'configuration folder: {AiiDAConfigDir.get()}')
         echo.echo_critical(str(exception))
     else:
         echo.echo_report(f'configuration folder: {config.dirpath}')

diff --git a/src/aiida/cmdline/commands/cmd_status.py b/src/aiida/cmdline/commands/cmd_status.py
@@ -61,13 +61,14 @@ def verdi_status(print_traceback, no_rmq):
     from aiida.common.docs import URL_NO_BROKER
     from aiida.common.exceptions import ConfigurationError
     from aiida.engine.daemon.client import DaemonException, DaemonNotRunningException
-    from aiida.manage.configuration.settings import AIIDA_CONFIG_FOLDER
+    from aiida.manage.configuration.settings import AiiDAConfigDir
     from aiida.manage.manager import get_manager
 
     exit_code = ExitCode.SUCCESS
+    configure_directory = AiiDAConfigDir.get()
 
     print_status(ServiceStatus.UP, 'version', f'AiiDA v{__version__}')
-    print_status(ServiceStatus.UP, 'config', AIIDA_CONFIG_FOLDER)
+    print_status(ServiceStatus.UP, 'config', configure_directory)
 
     manager = get_manager()
 

diff --git a/src/aiida/cmdline/params/options/commands/setup.py b/src/aiida/cmdline/params/options/commands/setup.py
@@ -66,11 +66,12 @@ def get_repository_uri_default(ctx):
     """
     import os
 
-    from aiida.manage.configuration.settings import AIIDA_CONFIG_FOLDER
+    from aiida.manage.configuration.settings import AiiDAConfigDir
 
     validate_profile_parameter(ctx)
+    configure_directory = AiiDAConfigDir.get()
 
-    return os.path.join(AIIDA_CONFIG_FOLDER, 'repository', ctx.params['profile'].name)
+    return os.path.join(configure_directory, 'repository', ctx.params['profile'].name)
 
 
 def get_quicksetup_repository_uri(ctx, param, value):

diff --git a/src/aiida/cmdline/utils/ascii_vis.py b/src/aiida/cmdline/utils/ascii_vis.py
@@ -29,7 +29,7 @@ def calc_info(node, call_link_label: bool = False) -> str:
         raise TypeError(f'Unknown type: {type(node)}')
 
     process_label = node.process_label
-    process_state = node.process_state.value.capitalize()
+    process_state = 'None' if node.process_state is None else node.process_state.value.capitalize()
     exit_status = node.exit_status
 
     if call_link_label and (caller := node.caller):

diff --git a/src/aiida/engine/daemon/client.py b/src/aiida/engine/daemon/client.py
@@ -94,10 +94,10 @@ def __init__(self, profile: Profile):
         from aiida.common.docs import URL_NO_BROKER
 
         type_check(profile, Profile)
-        config = get_config()
+        self._config = get_config()
         self._profile = profile
         self._socket_directory: str | None = None
-        self._daemon_timeout: int = config.get_option('daemon.timeout', scope=profile.name)
+        self._daemon_timeout: int = self._config.get_option('daemon.timeout', scope=profile.name)
 
         if self._profile.process_control_backend is None:
             raise ConfigurationError(
@@ -156,31 +156,31 @@ def virtualenv(self) -> str | None:
 
     @property
     def circus_log_file(self) -> str:
-        return self.profile.filepaths['circus']['log']
+        return self._config.filepaths(self.profile)['circus']['log']
 
     @property
     def circus_pid_file(self) -> str:
-        return self.profile.filepaths['circus']['pid']
+        return self._config.filepaths(self.profile)['circus']['pid']
 
     @property
     def circus_port_file(self) -> str:
-        return self.profile.filepaths['circus']['port']
+        return self._config.filepaths(self.profile)['circus']['port']
 
     @property
     def circus_socket_file(self) -> str:
-        return self.profile.filepaths['circus']['socket']['file']
+        return self._config.filepaths(self.profile)['circus']['socket']['file']
 
     @property
     def circus_socket_endpoints(self) -> dict[str, str]:
-        return self.profile.filepaths['circus']['socket']
+        return self._config.filepaths(self.profile)['circus']['socket']
 
     @property
     def daemon_log_file(self) -> str:
-        return self.profile.filepaths['daemon']['log']
+        return self._config.filepaths(self.profile)['daemon']['log']
 
     @property
     def daemon_pid_file(self) -> str:
-        return self.profile.filepaths['daemon']['pid']
+        return self._config.filepaths(self.profile)['daemon']['pid']
 
     def get_circus_port(self) -> int:
         """Retrieve the port for the circus controller, which should be written to the circus port file.

diff --git a/src/aiida/manage/configuration/__init__.py b/src/aiida/manage/configuration/__init__.py
@@ -65,10 +65,10 @@
 
 
 def get_config_path():
-    """Returns path to .aiida configuration directory."""
-    from .settings import AIIDA_CONFIG_FOLDER, DEFAULT_CONFIG_FILE_NAME
+    """Returns path to aiida configuration file."""
+    from .settings import DEFAULT_CONFIG_FILE_NAME, AiiDAConfigDir
 
-    return os.path.join(AIIDA_CONFIG_FOLDER, DEFAULT_CONFIG_FILE_NAME)
+    return os.path.join(AiiDAConfigDir.get(), DEFAULT_CONFIG_FILE_NAME)
 
 
 def load_config(create=False) -> 'Config':

diff --git a/src/aiida/manage/configuration/config.py b/src/aiida/manage/configuration/config.py
@@ -21,6 +21,7 @@
 import json
 import os
 import uuid
+from pathlib import Path
 from typing import Any, Dict, List, Optional, Tuple
 
 from pydantic import (
@@ -780,3 +781,32 @@ def _atomic_write(self, filepath=None):
 
             handle.flush()
             os.rename(handle.name, self.filepath)
+
+    def filepaths(self, profile: Profile):
+        """Return the filepaths used by a profile.
+
+        :return: a dictionary of filepaths
+        """
+        from aiida.manage.configuration.settings import AiiDAConfigPathResolver
+
+        _config_path_resolver: AiiDAConfigPathResolver = AiiDAConfigPathResolver(Path(self.dirpath))
+        daemon_dir = _config_path_resolver.daemon_dir
+        daemon_log_dir = _config_path_resolver.daemon_log_dir
+
+        return {
+            'circus': {
+                'log': str(daemon_log_dir / f'circus-{profile.name}.log'),
+                'pid': str(daemon_dir / f'circus-{profile.name}.pid'),
+                'port': str(daemon_dir / f'circus-{profile.name}.port'),
+                'socket': {
+                    'file': str(daemon_dir / f'circus-{profile.name}.sockets'),
+                    'controller': 'circus.c.sock',
+                    'pubsub': 'circus.p.sock',
+                    'stats': 'circus.s.sock',
+                },
+            },
+            'daemon': {
+                'log': str(daemon_log_dir / f'aiida-{profile.name}.log'),
+                'pid': str(daemon_dir / f'aiida-{profile.name}.pid'),
+            },
+        }
diff --git a/src/aiida/manage/configuration/profile.py b/src/aiida/manage/configuration/profile.py
@@ -56,7 +56,7 @@ def __init__(self, name: str, config: Mapping[str, Any], validate=True):
             )
 
         self._name = name
-        self._attributes: Dict[str, Any] = deepcopy(config)
+        self._attributes: Dict[str, Any] = deepcopy(config)  # type: ignore[arg-type]
 
         # Create a default UUID if not specified
         if self._attributes.get(self.KEY_UUID, None) is None:
@@ -235,22 +235,28 @@ def filepaths(self):
 
         :return: a dictionary of filepaths
         """
-        from .settings import DAEMON_DIR, DAEMON_LOG_DIR
+        from aiida.common.warnings import warn_deprecation
+        from aiida.manage.configuration.settings import AiiDAConfigPathResolver
+
+        warn_deprecation('This method has been deprecated, use `filepaths` method from `Config` obj instead', version=3)
+
+        daemon_dir = AiiDAConfigPathResolver().daemon_dir
+        daemon_log_dir = AiiDAConfigPathResolver().daemon_log_dir
 
         return {
             'circus': {
-                'log': str(DAEMON_LOG_DIR / f'circus-{self.name}.log'),
-                'pid': str(DAEMON_DIR / f'circus-{self.name}.pid'),
-                'port': str(DAEMON_DIR / f'circus-{self.name}.port'),
+                'log': str(daemon_log_dir / f'circus-{self.name}.log'),
+                'pid': str(daemon_dir / f'circus-{self.name}.pid'),
+                'port': str(daemon_dir / f'circus-{self.name}.port'),
                 'socket': {
-                    'file': str(DAEMON_DIR / f'circus-{self.name}.sockets'),
+                    'file': str(daemon_dir / f'circus-{self.name}.sockets'),
                     'controller': 'circus.c.sock',
                     'pubsub': 'circus.p.sock',
                     'stats': 'circus.s.sock',
                 },
             },
             'daemon': {
-                'log': str(DAEMON_LOG_DIR / f'aiida-{self.name}.log'),
-                'pid': str(DAEMON_DIR / f'aiida-{self.name}.pid'),
+                'log': str(daemon_log_dir / f'aiida-{self.name}.log'),
+                'pid': str(daemon_dir / f'aiida-{self.name}.pid'),
             },
         }