Categories: Python

【Python】任意の文字列が識別子として使用できるか判定する方法

この記事では、Pythonで任意の文字列が識別子として使用可能かどうかを判定する方法を解説します。

識別子に予約語や組み込み定数・関数と同じ名前を付けると思わぬエラーを引き起こす可能性があるので注意しましょう！

予約語と組み込み関数については以下の記事を参照してください。

【Python】予約語・組み込み関数一覧この記事では、Pythonの予約語と組み込み関数について解説しています。これらと同じ変数名や関数名は付けないように気をつけましょう！ソースコード内で任意の文字列が識別子として使用できるかを確認することも可能です。...

命名規則に則っているかどうかを判定する
予約語かどうかを判定する
組み込み定数名・関数名かどうかを判定する
識別子として使えるかどうかを判定する
まとめ

命名規則に則っているかどうかを判定する

str型のisidentifier()メソッドを使うことで命名規則に則っている文字列なのかをbool値で判別することができる。

str.isidentifier()

命名規則に則っているならばTrueが返され、則っていなければFalseが返されます。命名規則については変数の使い方を参照して下さい。

s = 'value'
print(s.isidentifier())

s = '1num'
print(s.isidentifier())

実行結果

True
False

isidentifier()メソッドは、文字列が予約語だった場合もTrueを返してしまうことに注意してください。

予約語かどうかを判定する

keywordモジュールのiskeyword()関数を使うことで任意の文字列が予約語かどうかを判定することができます。

from keyword import iskeyword

iskeyword(s)

s引数に指定した文字列が予約語ならTrueを返します。

from keyword import iskeyword

print(iskeyword('def'))
print(iskeyword('num'))
print(iskeyword('class'))

実行結果

True
False
True

組み込み定数名・関数名かどうかを判定する

組み込み関数名と同じ識別子は使えるには使えるが、名前を上書きしてしまうため元の関数が呼び出せなくなってしまう。

abs = 'abs関数に上書き'
print(abs(-123))

実行結果

TypeError: 'str' object is not callable

組み込み定数・関数はdir(__builtins__)で確認できる。

print(dir(__builtins__))

実行結果

['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException', 'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning', 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError', 'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning', 'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False', 'FileExistsError', 'FileNotFoundError', 'FloatingPointError', 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError', 'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError', 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError', 'MemoryError', 'ModuleNotFoundError', 'NameError', 'None', 'NotADirectoryError', 'NotImplemented', 'NotImplementedError', 'OSError', 'OverflowError', 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError', 'RecursionError', 'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning', 'StopAsyncIteration', 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError', 'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError', 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError', 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning', 'ValueError', 'Warning', 'ZeroDivisionError', '__build_class__', '__debug__', '__doc__', '__import__', '__loader__', '__name__', '__package__', '__spec__', 'abs', 'all', 'any', 'ascii', 'bin', 'bool', 'breakpoint', 'bytearray', 'bytes', 'callable', 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits', 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit', 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr', 'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass', 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview', 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property', 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice', 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars', 'zip']

つまり、in演算子を使うことで組み込み定数名・関数名かどうかを判定できる。

print('value' in dir(__builtins__))
print('abs' in dir(__builtins__))

実行結果

False
True

識別子として使えるかどうかを判定する

1つの関数で識別子として使えるかどうかを判定することはできなかったので先ほどの関数などを組み合わせて任意の文字列が識別子として使えるか判定する関数を定義してみます。

def isidentifier(s: str):

    from keyword import iskeyword

    if not s.isidentifier() or iskeyword(s) or s in dir(__builtins__):
        return False
    return True

print(isidentifier('num'))
print(isidentifier('1num'))
print(isidentifier('abs'))
print(isidentifier('if'))

実行結果