Robot Framework
Public Member Functions | Static Public Attributes | Properties | Private Member Functions | List of all members
robot.conf.languages.Language Class Reference

Base class for language definitions. More...

Inheritance diagram for robot.conf.languages.Language:
robot.conf.languages.Bg robot.conf.languages.Bs robot.conf.languages.Cs robot.conf.languages.De robot.conf.languages.En robot.conf.languages.Es robot.conf.languages.Fi robot.conf.languages.Fr robot.conf.languages.Hi robot.conf.languages.It robot.conf.languages.Nl robot.conf.languages.Pl robot.conf.languages.Pt robot.conf.languages.PtBr robot.conf.languages.Ro robot.conf.languages.Ru robot.conf.languages.Sv robot.conf.languages.Th robot.conf.languages.Tr robot.conf.languages.Uk robot.conf.languages.ZhCn robot.conf.languages.ZhTw

Public Member Functions

def __eq__ (self, other)
 
def __hash__ (self)
 
def code (cls)
 Language code like 'fi' or 'pt-BR'. More...
 
def from_name (cls, name)
 Return language class based on given name. More...
 
def name (cls)
 Language name like 'Finnish' or 'Brazilian Portuguese'. More...
 

Static Public Attributes

list and_prefixes = []
 
 arguments_setting = None
 
list but_prefixes = []
 
 comments_header = None
 
 documentation_setting = None
 
list false_strings = []
 
list given_prefixes = []
 
 keyword_tags_setting = None
 
 keywords_header = None
 
 library_setting = None
 
 metadata_setting = None
 
 resource_setting = None
 
 settings_header = None
 
 setup_setting = None
 
 suite_setup_setting = None
 
 suite_teardown_setting = None
 
 tags_setting = None
 
 task_setup_setting = None
 
 task_tags_setting = None
 
 task_teardown_setting = None
 
 task_template_setting = None
 
 task_timeout_setting = None
 
 tasks_header = None
 
 teardown_setting = None
 
 template_setting = None
 
 test_cases_header = None
 
 test_setup_setting = None
 
 test_tags_setting = None
 
 test_teardown_setting = None
 
 test_template_setting = None
 
 test_timeout_setting = None
 
list then_prefixes = []
 
 timeout_setting = None
 
list true_strings = []
 
 variables_header = None
 
 variables_setting = None
 
list when_prefixes = []
 

Properties

 bdd_prefixes = property
 
 headers = property
 
 settings = property
 

Private Member Functions

def bdd_prefixes (self)
 
def headers (self)
 
def settings (self)
 

Detailed Description

Base class for language definitions. 

New translations can be added by extending this class and setting class
attributes listed below.

Language :attr:`code` is got based on the class name and :attr:`name`
based on the docstring.

Definition at line 159 of file languages.py.

Member Function Documentation

◆ __eq__()

def robot.conf.languages.Language.__eq__ (   self,
  other 
)

Definition at line 296 of file languages.py.

◆ __hash__()

def robot.conf.languages.Language.__hash__ (   self)

Definition at line 299 of file languages.py.

◆ bdd_prefixes()

def robot.conf.languages.Language.bdd_prefixes (   self)
private

Definition at line 292 of file languages.py.

◆ code()

def robot.conf.languages.Language.code (   cls)

Language code like 'fi' or 'pt-BR'. 

    Got based on the class name. If the class name is two characters (or less),
    the code is just the name in lower case. If it is longer, a hyphen is added
    and the remainder of the class name is upper-cased.

    This special property can be accessed also directly from the class.

Definition at line 225 of file languages.py.

◆ from_name()

def robot.conf.languages.Language.from_name (   cls,
  name 
)

Return language class based on given name. 

    Name can either be a language name (e.g. 'Finnish' or 'Brazilian Portuguese')
    or a language code (e.g. 'fi' or 'pt-BR'). Matching is case and space
    insensitive and the hyphen is ignored when matching language codes.

    Raises `ValueError` if no matching language is found.

Definition at line 207 of file languages.py.

◆ headers()

def robot.conf.languages.Language.headers (   self)
private

Definition at line 248 of file languages.py.

◆ name()

def robot.conf.languages.Language.name (   cls)

Language name like 'Finnish' or 'Brazilian Portuguese'. 

    Got from the first line of the class docstring.

    This special property can be accessed also directly from the class.

Definition at line 240 of file languages.py.

◆ settings()

def robot.conf.languages.Language.settings (   self)
private

Definition at line 261 of file languages.py.

Member Data Documentation

◆ and_prefixes

list robot.conf.languages.Language.and_prefixes = []
static

Definition at line 193 of file languages.py.

◆ arguments_setting

robot.conf.languages.Language.arguments_setting = None
static

Definition at line 189 of file languages.py.

◆ but_prefixes

list robot.conf.languages.Language.but_prefixes = []
static

Definition at line 194 of file languages.py.

◆ comments_header

robot.conf.languages.Language.comments_header = None
static

Definition at line 165 of file languages.py.

◆ documentation_setting

robot.conf.languages.Language.documentation_setting = None
static

Definition at line 169 of file languages.py.

◆ false_strings

list robot.conf.languages.Language.false_strings = []
static

Definition at line 196 of file languages.py.

◆ given_prefixes

list robot.conf.languages.Language.given_prefixes = []
static

Definition at line 190 of file languages.py.

◆ keyword_tags_setting

robot.conf.languages.Language.keyword_tags_setting = None
static

Definition at line 183 of file languages.py.

◆ keywords_header

robot.conf.languages.Language.keywords_header = None
static

Definition at line 164 of file languages.py.

◆ library_setting

robot.conf.languages.Language.library_setting = None
static

Definition at line 166 of file languages.py.

◆ metadata_setting

robot.conf.languages.Language.metadata_setting = None
static

Definition at line 170 of file languages.py.

◆ resource_setting

robot.conf.languages.Language.resource_setting = None
static

Definition at line 167 of file languages.py.

◆ settings_header

robot.conf.languages.Language.settings_header = None
static

Definition at line 160 of file languages.py.

◆ setup_setting

robot.conf.languages.Language.setup_setting = None
static

Definition at line 185 of file languages.py.

◆ suite_setup_setting

robot.conf.languages.Language.suite_setup_setting = None
static

Definition at line 171 of file languages.py.

◆ suite_teardown_setting

robot.conf.languages.Language.suite_teardown_setting = None
static

Definition at line 172 of file languages.py.

◆ tags_setting

robot.conf.languages.Language.tags_setting = None
static

Definition at line 184 of file languages.py.

◆ task_setup_setting

robot.conf.languages.Language.task_setup_setting = None
static

Definition at line 174 of file languages.py.

◆ task_tags_setting

robot.conf.languages.Language.task_tags_setting = None
static

Definition at line 182 of file languages.py.

◆ task_teardown_setting

robot.conf.languages.Language.task_teardown_setting = None
static

Definition at line 176 of file languages.py.

◆ task_template_setting

robot.conf.languages.Language.task_template_setting = None
static

Definition at line 178 of file languages.py.

◆ task_timeout_setting

robot.conf.languages.Language.task_timeout_setting = None
static

Definition at line 180 of file languages.py.

◆ tasks_header

robot.conf.languages.Language.tasks_header = None
static

Definition at line 163 of file languages.py.

◆ teardown_setting

robot.conf.languages.Language.teardown_setting = None
static

Definition at line 186 of file languages.py.

◆ template_setting

robot.conf.languages.Language.template_setting = None
static

Definition at line 187 of file languages.py.

◆ test_cases_header

robot.conf.languages.Language.test_cases_header = None
static

Definition at line 162 of file languages.py.

◆ test_setup_setting

robot.conf.languages.Language.test_setup_setting = None
static

Definition at line 173 of file languages.py.

◆ test_tags_setting

robot.conf.languages.Language.test_tags_setting = None
static

Definition at line 181 of file languages.py.

◆ test_teardown_setting

robot.conf.languages.Language.test_teardown_setting = None
static

Definition at line 175 of file languages.py.

◆ test_template_setting

robot.conf.languages.Language.test_template_setting = None
static

Definition at line 177 of file languages.py.

◆ test_timeout_setting

robot.conf.languages.Language.test_timeout_setting = None
static

Definition at line 179 of file languages.py.

◆ then_prefixes

list robot.conf.languages.Language.then_prefixes = []
static

Definition at line 192 of file languages.py.

◆ timeout_setting

robot.conf.languages.Language.timeout_setting = None
static

Definition at line 188 of file languages.py.

◆ true_strings

list robot.conf.languages.Language.true_strings = []
static

Definition at line 195 of file languages.py.

◆ variables_header

robot.conf.languages.Language.variables_header = None
static

Definition at line 161 of file languages.py.

◆ variables_setting

robot.conf.languages.Language.variables_setting = None
static

Definition at line 168 of file languages.py.

◆ when_prefixes

list robot.conf.languages.Language.when_prefixes = []
static

Definition at line 191 of file languages.py.

Property Documentation

◆ bdd_prefixes

robot.conf.languages.Language.bdd_prefixes = property
static

Definition at line 290 of file languages.py.

◆ headers

robot.conf.languages.Language.headers = property
static

Definition at line 246 of file languages.py.

◆ settings

robot.conf.languages.Language.settings = property
static

Definition at line 259 of file languages.py.

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