如何键入注释字符串的长度？

Question

我想在 python 中键入一个只接受单个字符的函数，举个例子： (s: str) -> int

由于 Python 没有单个字符的类型，因此您不能只执行(s: char) -> int之类的操作。

有什么方法可以让s: str只能是一个字符吗？

我可以看到这在编写代码时的提示中很有用。

这是我的完整示例：

import unicodedata

roman_numeral_lookup = {"I": 1, "V": 5, "X": 10, ...}

def exact_roman_numeral(s: str) -> int:
    """Return the value of a single Roman numeral. Dosen't support multicharacter roman numerals such as 'XII' or Apostrophus."""

    # Convert Unicode Roman numerals into to their normalised text version. e.g. Ⅹ -> X, ⅰ -> I
    s = unicodedata.normalize("NFKC", s).upper()

    if s in roman_numeral_lookup:
        return roman_numeral_lookup[s]

    else:  # Some form of invalid value.
        if not isinstance(s, str):
            raise TypeError("Argument must be of type str.")
        elif len(s) != 1:
            raise ValueError("Must be a single Roman numeral.")
        else:
            raise ValueError("Not a valid/supported Roman numeral.")

（我知道错误不是最好的）

Answer 1

好吧，理论上不应像您希望的那样使用类型注释 - 意思是，并非代码中的每个约束都应由类型注释表示。

现在，要回答您的问题，您当然可以构建自己的类型注释，但 IMO 工作量太大，结果太少。

SO上有其他答案描述了如何定义自定义注释

您可以随时：

• 在您的文档字符串中描述您的变量应该是 1 字符长
• 进行健全性/验证检查并引发适当的异常。
• 使用Marshmallow 之类的东西来清理/序列化您的数据

Answer 2

原生地，没有。 注释无法满足您的要求。 但...

您可以创建一个新类型来支持您的字符串长度等规则，然后在您的注释中使用该类型。

class MyStringThatShouldOnlyBeOneCharacter:
    def __init__(self, text):
        self.text = text
        # put your value checking here
        return

def exact_roman_numeral(s: MyStringThatShouldOnlyBeOneCharacter) -> int:
    ...