pycodeanalyzer.core.configuration.configuration

Summary

Classes:

Configuration

Configuration of pycodeanalyzer.

Diagrams

Configuration

classDiagram class Configuration { <<Class>> + Any logger + Any config + Dict<str,List<Tuple<str,str>>> definition +Constructor() None +load(str path) bool +defineConfig(str section, str name, str comment) None +get(str section, str name) str +getInt(str section, str name) int +getFloat(str section, str name) float +getBool(str section, str name) bool +getList(str section, str name) List~Any~ +generateTemplate(str path) None }
Configuration class diagram

Reference

class pycodeanalyzer.core.configuration.configuration.Configuration[source]

Bases: object

Configuration of pycodeanalyzer.

This class allow to parse and use configuration with a INI format.

load(path: str) → bool[source]

Load configuration file.

Read and load the configuration from a INI config file.

defineConfig(section: str, name: str, comment: str) → None[source]

Define a configuration.

This function allow to define a configuration. This is used for template generation.

get(section: str, name: str) → Optional[str][source]: Get value from configuation

getInt(section: str, name: str) → Optional[int][source]: Get value from configuation

getFloat(section: str, name: str) → Optional[float][source]: Get value from configuation

getBool(section: str, name: str) → Optional[bool][source]: Get value from configuation

getList(section: str, name: str) → Optional[List[Any]][source]: Get value from configuation

generateTemplate(path: str) → None[source]: Generate configuration template.

This file was automatically generated using better_apidoc.