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

Public Member Functions

def __init__ (self, name, email)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __hash__ (self)
 
def __str__ (self)
 
def __repr__ (self)
 
def committer (cls, config_reader=None)
 
def author (cls, config_reader=None)
 

Data Fields

 name
 
 email
 

Static Public Attributes

 name_only_regex
 
 name_email_regex
 
 env_author_name
 
 env_author_email
 
 env_committer_name
 
 env_committer_email
 
 conf_name
 
 conf_email
 

Detailed Description

Actors hold information about a person acting on the repository. They
can be committers and authors or anything with a name and an email as
mentioned in the git log entries.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name,
  email 
)

Member Function Documentation

◆ __eq__()

def __eq__ (   self,
  other 
)

◆ __hash__()

def __hash__ (   self)

◆ __ne__()

def __ne__ (   self,
  other 
)

◆ __repr__()

def __repr__ (   self)

◆ __str__()

def __str__ (   self)

◆ author()

def author (   cls,
  config_reader = None 
)
Same as committer(), but defines the main author. It may be specified in the environment,
but defaults to the committer

◆ committer()

def committer (   cls,
  config_reader = None 
)
:return: Actor instance corresponding to the configured committer. It behaves
    similar to the git implementation, such that the environment will override
    configuration values of config_reader. If no value is set at all, it will be
    generated
:param config_reader: ConfigReader to use to retrieve the values from in case
    they are not set in the environment

Field Documentation

◆ conf_email

conf_email
static

◆ conf_name

conf_name
static

◆ email

email

◆ env_author_email

env_author_email
static

◆ env_author_name

env_author_name
static

◆ env_committer_email

env_committer_email
static

◆ env_committer_name

env_committer_name
static

◆ name

name

◆ name_email_regex

name_email_regex
static

◆ name_only_regex

name_only_regex
static

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