org.sonar.python.semantic.BuiltinSymbols Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of python-frontend Show documentation
The newest version!
/*
 * SonarQube Python Plugin
 * Copyright (C) 2011-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.python.semantic;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

public class BuiltinSymbols {

  private BuiltinSymbols() {
    // empty constructor
  }


  public static final String CLASS_METHOD_DECORATOR = "classmethod";
  public static final String STATIC_METHOD_DECORATOR = "staticmethod";

  /**
   * See https://docs.python.org/3/library/constants.html#built-in-consts
   */
  public static final Set CONSTANTS = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
    "True", "False", "None", "NotImplemented", "__debug__", "copyright", "credits", "license", "quit", "exit", "Ellipsis")));

  /**
   * See https://docs.python.org/3/reference/import.html?highlight=__package__#import-related-module-attributes
   */
  public static final Set MODULE_ATTRIBUTES = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
    "__name__", "__loader__", "__package__", "__spec__", "__path__", "__file__", "__cached__", "__doc__", "__builtins__")));

  /**
   * See https://docs.python.org/3/library/functions.html
   */
  public static final Set FUNCTIONS = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
    "abs",
    "delattr",
    "hash",
    "memoryview",
    "set",
    "all",
    "dict",
    "help",
    "min",
    "setattr",
    "any",
    "dir",
    "hex",
    "next",
    "slice",
    "ascii",
    "divmod",
    "id",
    "object",
    "sorted",
    "bin",
    "enumerate",
    "input",
    "oct",
    STATIC_METHOD_DECORATOR,
    "bool",
    "eval",
    "int",
    "open",
    "str",
    "breakpoint",
    "exec",
    "isinstance",
    "ord",
    "sum",
    "bytearray",
    "filter",
    "issubclass",
    "pow",
    "super",
    "bytes",
    "float",
    "iter",
    "print",
    "tuple",
    "callable",
    "format",
    "len",
    "property",
    "type",
    "chr",
    "frozenset",
    "list",
    "range",
    "vars",
    CLASS_METHOD_DECORATOR,
    "getattr",
    "locals",
    "repr",
    "zip",
    "compile",
    "globals",
    "map",
    "reversed",
    "__import__",
    "complex",
    "hasattr",
    "max",
    "round")));

  /**
   * See https://docs.python.org/2.7/library/functions.html
   */
  public static final Set FUNCTIONS_PYTHON2 = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
    "abs",
    "divmod",
    "input",
    "open",
    STATIC_METHOD_DECORATOR,
    "all",
    "enumerate",
    "int",
    "ord",
    "str",
    "any",
    "eval",
    "isinstance",
    "pow",
    "sum",
    "basestring",
    "execfile",
    "issubclass",
    "print",
    "super2",
    "bin",
    "file",
    "iter",
    "property",
    "tuple",
    "bool",
    "filter",
    "len",
    "range",
    "type",
    "bytearray",
    "float",
    "list",
    "raw_input",
    "unichr",
    "callable",
    "format",
    "locals",
    "reduce",
    "unicode",
    "chr",
    "frozenset",
    "long",
    "reload",
    "vars",
    CLASS_METHOD_DECORATOR,
    "getattr",
    "map",
    "repr",
    "xrange",
    "cmp",
    "globals",
    "max",
    "reversed",
    "zip",
    "compile",
    "hasattr",
    "memoryview",
    "round",
    "__import__",
    "complex",
    "hash",
    "min",
    "set",
    "delattr",
    "help",
    "next",
    "setattr",
    "dict",
    "hex",
    "object",
    "slice",
    "dir",
    "id",
    "oct",
    "sorted",
    "apply",
    "buffer",
    "coerce",
    "intern"
  )));

  /**
   * See https://docs.python.org/3/library/exceptions.html
   */
  public static final Set EXCEPTIONS = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
    "BaseException",
    "SystemExit",
    "KeyboardInterrupt",
    "GeneratorExit",
    "Exception",
    "StopIteration",
    "StopAsyncIteration",
    "ArithmeticError",
    "FloatingPointError",
    "OverflowError",
    "ZeroDivisionError",
    "AssertionError",
    "AttributeError",
    "BufferError",
    "EOFError",
    "ImportError",
    "ModuleNotFoundError",
    "LookupError",
    "IndexError",
    "KeyError",
    "MemoryError",
    "NameError",
    "UnboundLocalError",
    "OSError",
    "BlockingIOError",
    "ChildProcessError",
    "ConnectionError",
    "BrokenPipeError",
    "ConnectionAbortedError",
    "ConnectionRefusedError",
    "ConnectionResetError",
    "FileExistsError",
    "FileNotFoundError",
    "InterruptedError",
    "IsADirectoryError",
    "NotADirectoryError",
    "PermissionError",
    "ProcessLookupError",
    "TimeoutError",
    "ReferenceError",
    "RuntimeError",
    "NotImplementedError",
    "RecursionError",
    "SyntaxError",
    "IndentationError",
    "TabError",
    "SystemError",
    "TypeError",
    "ValueError",
    "UnicodeError",
    "UnicodeDecodeError",
    "UnicodeEncodeError",
    "UnicodeTranslateError",
    "Warning",
    "DeprecationWarning",
    "PendingDeprecationWarning",
    "RuntimeWarning",
    "SyntaxWarning",
    "UserWarning",
    "FutureWarning",
    "ImportWarning",
    "UnicodeWarning",
    "BytesWarning",
    "ResourceWarning"
  )));

  /**
   * See https://docs.python.org/2.7/library/exceptions.html
   */
  public static final Set EXCEPTIONS_PYTHON2 = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
    "BaseException",
    "SystemExit",
    "KeyboardInterrupt",
    "GeneratorExit",
    "Exception",
    "StopIteration",
    "StandardError",
    "BufferError",
    "ArithmeticError",
    "FloatingPointError",
    "OverflowError",
    "ZeroDivisionError",
    "AssertionError",
    "AttributeError",
    "EnvironmentError",
    "IOError",
    "OSError",
    "WindowsError",
    "VMSError",
    "EOFError",
    "ImportError",
    "LookupError",
    "IndexError",
    "KeyError",
    "MemoryError",
    "NameError",
    "UnboundLocalError",
    "ReferenceError",
    "RuntimeError",
    "NotImplementedError",
    "SyntaxError",
    "IndentationError",
    "TabError",
    "SystemError",
    "TypeError",
    "ValueError",
    "UnicodeError",
    "UnicodeDecodeError",
    "UnicodeEncodeError",
    "UnicodeTranslateError",
    "Warning",
    "DeprecationWarning",
    "PendingDeprecationWarning",
    "RuntimeWarning",
    "SyntaxWarning",
    "UserWarning",
    "FutureWarning",
    "ImportWarning",
    "UnicodeWarning",
    "BytesWarning"
  )));

  public static Set all() {
    Set all = new HashSet<>();
    all.addAll(BuiltinSymbols.CONSTANTS);
    all.addAll(BuiltinSymbols.FUNCTIONS);
    all.addAll(BuiltinSymbols.FUNCTIONS_PYTHON2);
    all.addAll(BuiltinSymbols.EXCEPTIONS);
    all.addAll(BuiltinSymbols.EXCEPTIONS_PYTHON2);
    all.addAll(BuiltinSymbols.MODULE_ATTRIBUTES);
    return all;
  }

  public static final Set STATIC_AND_CLASS_METHOD_DECORATORS = Set.of(CLASS_METHOD_DECORATOR, STATIC_METHOD_DECORATOR);
}