Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Testing: Add type annotations to config.py #6609

Merged
merged 1 commit into from Apr 18, 2024
Merged

Testing: Add type annotations to config.py #6609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
74 changes: 37 additions & 37 deletions lib/rucio/common/config.py
View file
Open in desktop
Expand Up @@ -18,7 +18,7 @@
import json
import os
from collections.abc import Callable
from typing import TYPE_CHECKING, Optional, TypeVar, Union, overload
from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, overload

from rucio.common import exception
from rucio.common.exception import ConfigNotFound, DatabaseException
Expand All @@ -30,7 +30,7 @@
from sqlalchemy.orm import Session


def convert_to_any_type(value) -> Union[bool, int, float, str]:
def convert_to_any_type(value: str) -> Union[bool, int, float, str]:
if value.lower() in ['true', 'yes', 'on']:
return True
elif value.lower() in ['false', 'no', 'off']:
Expand All @@ -45,7 +45,7 @@ def convert_to_any_type(value) -> Union[bool, int, float, str]:
return value


def _convert_to_boolean(value):
def _convert_to_boolean(value: Union[str, bool]) -> bool:
if isinstance(value, bool):
return value
if value.lower() in ['true', 'yes', 'on', '1']:
Expand Down Expand Up @@ -297,7 +297,7 @@ def config_get_int(
def config_get_int(
section: str,
option: str,
raise_exception,
raise_exception: bool,
default: _T = ...,
*,
check_config_table: bool = ...,
Expand All @@ -309,14 +309,14 @@ def config_get_int(


def config_get_int(
section,
option,
raise_exception=True,
section: str,
option: str,
raise_exception: bool = True,
default=None,
check_config_table=True,
session=None,
use_cache=True,
expiration_time=900,
check_config_table: bool = True,
session: "Optional[Session]" = None,
use_cache: bool = True,
expiration_time: int = 900,
):
"""
Return the integer value for a given option in a section
Expand Down Expand Up @@ -395,14 +395,14 @@ def config_get_float(


def config_get_float(
section,
option,
raise_exception=True,
section: str,
option: str,
raise_exception: bool = True,
default=None,
check_config_table=True,
session=None,
use_cache=True,
expiration_time=900,
check_config_table: bool = True,
session: "Optional[Session]" = None,
use_cache: bool = True,
expiration_time: int = 900,
):
"""
Return the floating point value for a given option in a section
Expand Down Expand Up @@ -482,14 +482,14 @@ def config_get_bool(


def config_get_bool(
section,
option,
raise_exception=True,
section: str,
option: str,
raise_exception: bool = True,
default=None,
check_config_table=True,
session=None,
use_cache=True,
expiration_time=900,
check_config_table: bool = True,
session: "Optional[Session]" = None,
use_cache: bool = True,
expiration_time: int = 900,
):
"""
Return the boolean value for a given option in a section
Expand Down Expand Up @@ -569,14 +569,14 @@ def config_get_list(


def config_get_list(
section,
option,
raise_exception=True,
section: str,
option: str,
raise_exception: bool = True,
default=None,
check_config_table=True,
session=None,
use_cache=True,
expiration_time=900,
check_config_table: bool = True,
session: "Optional[Session]" = None,
use_cache: bool = True,
expiration_time: int = 900,
):
"""
Return a list for a given option in a section
Expand Down Expand Up @@ -691,7 +691,7 @@ def config_remove_option(section: str, option: str) -> bool:
return get_config().remove_option(section, option)


def config_set(section: str, option: str, value: str):
def config_set(section: str, option: str, value: str) -> None:
"""
Set a configuration option in a given section.

Expand All @@ -704,7 +704,7 @@ def config_set(section: str, option: str, value: str):
return get_config().set(section, option, value)


def get_config_dirs():
def get_config_dirs() -> list[str]:
"""
Returns all available configuration directories in order:
- $RUCIO_HOME/etc/
Expand All @@ -724,7 +724,7 @@ def get_config_dirs():
return configdirs


def get_lfn2pfn_algorithm_default():
def get_lfn2pfn_algorithm_default() -> str:
"""Returns the default algorithm name for LFN2PFN translation for this server."""
default_lfn2pfn = "hash"
try:
Expand All @@ -734,7 +734,7 @@ def get_lfn2pfn_algorithm_default():
return default_lfn2pfn


def get_rse_credentials(path_to_credentials_file: Optional[Union[str, os.PathLike]] = None):
def get_rse_credentials(path_to_credentials_file: Optional[Union[str, os.PathLike]] = None) -> dict[str, Any]:
""" Returns credentials for RSEs. """

path = ''
Expand Down Expand Up @@ -765,7 +765,7 @@ def get_config() -> configparser.ConfigParser:
return __CONFIG.parser


def clean_cached_config():
def clean_cached_config() -> None:
"""Deletes the cached config singleton instance."""
global __CONFIG
__CONFIG = None
Expand Down