Source code for nvflare.apis.utils.format_check

# Copyright (c) 2021, NVIDIA CORPORATION.  All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import inspect
import re
from functools import wraps

type_pattern_mapping = {
    "server": r"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$",
    "overseer": r"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$",
    "sp_end_point": r"^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):[0-9]*:[0-9]*)$",
    "client": r"^[A-Za-z0-9-_]+$",
    "admin": r"^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$",
    "email": r"^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$",
    "org": r"^[A-Za-z0-9_]+$",
}


[docs]def name_check(name: str, entity_type: str): regex_pattern = type_pattern_mapping.get(entity_type) if regex_pattern is None: return True, "entity_type={} not defined, unable to check name={}.".format(entity_type, name) if re.match(regex_pattern, name): return False, "name={} passed on regex_pattern={} check".format(name, regex_pattern) else: return True, "name={} is ill-formatted based on regex_pattern={}".format(name, regex_pattern)
[docs]def validate_class_methods_args(cls): for name, method in inspect.getmembers(cls, inspect.isfunction): if name != "__init_subclass__": setattr(cls, name, validate_args(method)) return cls
[docs]def validate_args(method): signature = inspect.signature(method) @wraps(method) def wrapper(*args, **kwargs): bound_arguments = signature.bind(*args, **kwargs) for name, value in bound_arguments.arguments.items(): annotation = signature.parameters[name].annotation if not (annotation is inspect.Signature.empty or isinstance(value, annotation)): raise TypeError( "argument '{}' of {} must be {} but got {}".format(name, method, annotation, type(value)) ) return method(*args, **kwargs) return wrapper