From 1fc0edb9fa0d49bf6989ef1b6f876810b48ebf8c Mon Sep 17 00:00:00 2001 From: Guillaume Abrioux Date: Tue, 7 Jan 2025 09:22:00 +0000 Subject: [PATCH] ceph-volume: add python hints to util.prepare.create_id() This commit introduces type annotations to the `create_id` function in `ceph_volume.util.prepare`. The parameters and return value are now typed as follows: - `fsid` is a `str`. - `json_secrets` is a `str`. - `osd_id` is an optional `str` (`Optional[str]`). - The function returns a `str`. Signed-off-by: Guillaume Abrioux --- src/ceph-volume/ceph_volume/util/prepare.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/ceph-volume/ceph_volume/util/prepare.py b/src/ceph-volume/ceph_volume/util/prepare.py index 9c863b83d93..ff7fc023fc4 100644 --- a/src/ceph-volume/ceph_volume/util/prepare.py +++ b/src/ceph-volume/ceph_volume/util/prepare.py @@ -9,6 +9,7 @@ import logging import json from ceph_volume import process, conf, terminal from ceph_volume.util import system, constants, str_to_int, disk +from typing import Optional logger = logging.getLogger(__name__) mlogger = terminal.MultiLogger(__name__) @@ -121,7 +122,7 @@ def get_block_wal_size(lv_format=True): return wal_size -def create_id(fsid, json_secrets, osd_id=None): +def create_id(fsid: str, json_secrets: str, osd_id: Optional[str]=None) -> str: """ :param fsid: The osd fsid to create, always required :param json_secrets: a json-ready object with whatever secrets are wanted -- 2.39.5