1#
2# Licensed to the Apache Software Foundation (ASF) under one
3# or more contributor license agreements. See the NOTICE file
4# distributed with this work for additional information
5# regarding copyright ownership. The ASF licenses this file
6# to you under the Apache License, Version 2.0 (the
7# "License"); you may not use this file except in compliance
8# with the License. You may obtain a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing,
13# software distributed under the License is distributed on an
14# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15# KIND, either express or implied. See the License for the
16# specific language governing permissions and limitations
17# under the License.
18
19from __future__ import annotations
20
21from typing import TYPE_CHECKING, TypeVar
22
23if TYPE_CHECKING:
24 from typing_extensions import TypeIs
25
26 T = TypeVar("T")
27
28__all__ = ["NOTSET", "ArgNotSet", "is_arg_set"]
29
30
31class ArgNotSet:
32 """Sentinel type for annotations, useful when None is not viable."""
33
34
35NOTSET = ArgNotSet()
36"""Sentinel value for argument default. See ``ArgNotSet``."""
37
38
39def is_arg_set(value: T | ArgNotSet) -> TypeIs[T]:
40 return not isinstance(value, ArgNotSet)