statick_tool.plugins.discovery package

Module contents

Default discovery plugins for statick.

Submodules

statick_tool.plugins.discovery.c_discovery_plugin module

Discover C files to analyze.

class statick_tool.plugins.discovery.c_discovery_plugin.CDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discover C/C++ files to analyze.

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for C files.

statick_tool.plugins.discovery.cmake_discovery_plugin module

Discovery plugin to find CMake-based projects.

From the CMake manual, valid CMake files are named CMakeLists.txt and *.cmake. This module will find those files and make them available as part of the package data.

https://cmake.org/cmake/help/latest/manual/cmake-language.7.html

The contents of CMakeLists.txt is used to discover make targets and header files for the current package. That information is made available as part of the package data.

class statick_tool.plugins.discovery.cmake_discovery_plugin.CMakeDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discovery plugin to find CMake-based projects.

gather_args(args: argparse.Namespace) → None[source]

Gather arguments.

classmethod get_discovery_dependencies() → List[str][source]

Get a list of plugins that must run before this one.

get_name() → str[source]

Get name of discovery type.

classmethod process_output(output: str, package: statick_tool.package.Package) → None[source]

Parse the tool output.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for CMake files.

statick_tool.plugins.discovery.groovy_discovery_plugin module

Discover Groovy files to analyze.

class statick_tool.plugins.discovery.groovy_discovery_plugin.GroovyDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discover Groovy files to analyze.

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for Groovy files.

statick_tool.plugins.discovery.java_discovery_plugin module

Discover Java files to analyze.

class statick_tool.plugins.discovery.java_discovery_plugin.JavaDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discover Java files to analyze.

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for java files.

statick_tool.plugins.discovery.maven_discovery_plugin module

Discover Maven POM files to analyze.

class statick_tool.plugins.discovery.maven_discovery_plugin.MavenDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discover Maven files to analyze.

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for maven files.

statick_tool.plugins.discovery.perl_discovery_plugin module

Discover Perl files to analyze.

class statick_tool.plugins.discovery.perl_discovery_plugin.PerlDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discover Perl files to analyze.

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for Perl files.

statick_tool.plugins.discovery.python_discovery_plugin module

Discover python files to analyze.

class statick_tool.plugins.discovery.python_discovery_plugin.PythonDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discover python files to analyze.

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for python files.

statick_tool.plugins.discovery.ros_discovery_plugin module

Discovery plugin to find ROS packages.

class statick_tool.plugins.discovery.ros_discovery_plugin.RosDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discovery plugin to find ROS packages.

classmethod deep_get(dictionary: Union[str, Dict[Any, str]], keys: str, default: Optional[str] = None) → Any[source]

Safe way to check for a value in a nested dict.

Copied from:

https://stackoverflow.com/questions/25833613/python-safe-method-to-get-value-of-nested-dictionary

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for ROS package files.

statick_tool.plugins.discovery.shell_discovery_plugin module

Discover shell files to analyze.

class statick_tool.plugins.discovery.shell_discovery_plugin.ShellDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discover shell files to analyze.

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for shell files.

statick_tool.plugins.discovery.xml_discovery_plugin module

Discover XML files to analyze.

class statick_tool.plugins.discovery.xml_discovery_plugin.XMLDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discover XML files to analyze.

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for XML files.

statick_tool.plugins.discovery.yaml_discovery_plugin module

Discover YAML files to analyze.

class statick_tool.plugins.discovery.yaml_discovery_plugin.YAMLDiscoveryPlugin[source]

Bases: statick_tool.discovery_plugin.DiscoveryPlugin

Discover YAML files to analyze.

get_name() → str[source]

Get name of discovery type.

scan(package: statick_tool.package.Package, level: str, exceptions: Optional[statick_tool.exceptions.Exceptions] = None) → None[source]

Scan package looking for YAML files.