OpenQuizz
Une application de gestion des contenus pédagogiques
ConfigurationCommand Class Reference
Inheritance diagram for ConfigurationCommand:
Collaboration diagram for ConfigurationCommand:

Public Member Functions

def add_options (self)
 
def run (self, options, args)
 
def list_values (self, options, args)
 
def get_name (self, options, args)
 
def set_name_value (self, options, args)
 
def unset_name (self, options, args)
 
def list_config_values (self, options, args)
 
def print_config_file_values (self, variant)
 
def print_env_var_values (self)
 
def open_in_editor (self, options, args)
 
- Public Member Functions inherited from Command
def __init__ (self, name, summary, isolated=False)
 
def handle_pip_version_check (self, options)
 
def parse_args (self, args)
 
def main (self, args)
 
- Public Member Functions inherited from CommandContextMixIn
def __init__ (self)
 
def main_context (self)
 
def enter_context (self, context_provider)
 

Data Fields

 configuration
 
- Data Fields inherited from Command
 name
 
 summary
 
 parser
 
 tempdir_registry
 
 cmd_opts
 
 verbosity
 

Static Public Attributes

 ignore_require_venv
 
 usage
 
- Static Public Attributes inherited from Command
 usage
 
 ignore_require_venv
 

Detailed Description

Manage local and global configuration.

Subcommands:

- list: List the active configuration (or from the file specified)
- edit: Edit the configuration file in an editor
- get: Get the value associated with name
- set: Set the name=value
- unset: Unset the value associated with name
- debug: List the configuration files and values defined under them

If none of --user, --global and --site are passed, a virtual
environment configuration file is used if one is active and the file
exists. Otherwise, all modifications happen on the to the user file by
default.

Member Function Documentation

◆ add_options()

def add_options (   self)

Reimplemented from Command.

◆ get_name()

def get_name (   self,
  options,
  args 
)

◆ list_config_values()

def list_config_values (   self,
  options,
  args 
)
List config key-value pairs across different config files

◆ list_values()

def list_values (   self,
  options,
  args 
)

◆ open_in_editor()

def open_in_editor (   self,
  options,
  args 
)

◆ print_config_file_values()

def print_config_file_values (   self,
  variant 
)
Get key-value pairs from the file of a variant

◆ print_env_var_values()

def print_env_var_values (   self)
Get key-values pairs present as environment variables

◆ run()

def run (   self,
  options,
  args 
)

Reimplemented from Command.

◆ set_name_value()

def set_name_value (   self,
  options,
  args 
)

◆ unset_name()

def unset_name (   self,
  options,
  args 
)

Field Documentation

◆ configuration

configuration

◆ ignore_require_venv

ignore_require_venv
static

◆ usage

usage
static

The documentation for this class was generated from the following file: