Settings

class oceanai.modules.core.settings.Settings(lang: str = 'ru', color_simple: str = '#666', color_info: str = '#1776D2', color_err: str = '#FF0000', color_true: str = '#008001', bold_text: bool = True, text_runtime: str = '', num_to_df_display: int = 30)[source]

Bases: Messages

Class for settings

Parameters:

  • lang (str) – See lang

  • color_simple (str) – Plain text color (hexadecimal code)

  • color_info (str) – The color of the text containing the information (hexadecimal code)

  • color_err (str) – Error text color (hexadecimal code)

  • color_true (str) – Text color containing positive information (hexadecimal code)

  • bold_text (bool) – Bold text

  • num_to_df_display (int) – Number of rows to display in tables

  • text_runtime (str) – Runtime text

bold_text: bool = True

Bold text

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en')
4print(settings.bold_text, settings.bold_text_)
[1]:
1True True

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', bold_text = True)
4print(settings.bold_text, settings.bold_text_)
[2]:
1True True

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', bold_text = False)
4print(settings.bold_text, settings.bold_text_)
[3]:
1False False

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', bold_text = 1)
4print(settings.bold_text, settings.bold_text_)
[4]:
1True True

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', bold_text = 'some_text')
4print(settings.bold_text, settings.bold_text_)
[5]:
1True True
Type:

bool

property bold_text_: bool

Getting and setting bold text

Parameters:

(bool) – True or False

Returns:

True or False

Return type:

bool

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', bold_text = True)
4print(settings.bold_text_)
[1]:
1True

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', bold_text = True)
4settings.bold_text_ = False
5print(settings.bold_text_)
[2]:
1False

Better not to do that – 1 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', bold_text = False)
4settings.bold_text_ = 1
5print(settings.bold_text_)
[3]:
1False

– 2 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', bold_text = True)
4settings.bold_text_ = 'some_text'
5print(settings.bold_text_)
[4]:
1True
property chunk_size_: int

Getting/setting file download size from network in 1 step

Parameters:

(int) – File download size from network in 1 step

Returns:

File download size from network in 1 step

Return type:

int

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.chunk_size_)
[1]:
11000000

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.chunk_size_ = 2000000
5print(settings.chunk_size_)
[2]:
12000000

Better not to do that – 1 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.chunk_size_ = -1
5print(settings.chunk_size_)
[3]:
11000000

– 2 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.chunk_size_ = False
5print(settings.chunk_size_)
[4]:
11000000

– 3 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.chunk_size_ = 'some_text'
5print(settings.chunk_size_)
[5]:
11000000
color_err: str = '#FF0000'

Error text color (hexadecimal code)

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.color_err, settings.color_err_)
[1]:
1#FF0000 #FF0000

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_err = 'FF0000')
4print(settings.color_err, settings.color_err_)
[2]:
1#FF0000 #FF0000

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_err = '#FF0')
4print(settings.color_err, settings.color_err_)
[3]:
1#FF0 #FF0

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_err = 1)
4print(settings.color_err, settings.color_err_)
[4]:
1#FF0000 #FF0000

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_err = [])
4print(settings.color_err, settings.color_err_)
[5]:
1#FF0000 #FF0000
Type:

str

property color_err_: str

Getting/setting the color of the text containing the error

Parameters:

(str) – Hex code

Returns:

Hex code

Return type:

str

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_err = '#C22931')
4print(settings.color_err_)
[1]:
1#C22931

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_err_ = '#FF0'
5print(settings.color_err_)
[2]:
1#FF0

Better not to do that – 1 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_err_ = 1
5print(settings.color_err_)
[3]:
1#FF0000

– 2 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_err_ = {}
5print(settings.color_err_)
[4]:
1#FF0000
color_info: str = '#1776D2'

The color of the text containing the information (hexadecimal code)

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.color_info, settings.color_info_)
[1]:
1#1776D2 #1776D2

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_info = '#1776D2')
4print(settings.color_info, settings.color_info_)
[2]:
1#1776D2 #1776D2

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_info = '#42F')
4print(settings.color_info, settings.color_info_)
[3]:
1#42F #42F

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_info = 1)
4print(settings.color_info, settings.color_info_)
[4]:
1#1776D2 #1776D2

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_info = [])
4print(settings.color_info, settings.color_info_)
[5]:
1#1776D2 #1776D2
Type:

str

property color_info_: str

Getting/setting the color of the text containing the information

Parameters:

(str) – Hex code

Returns:

Hex code

Return type:

str

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_info = '#1776D2')
4print(settings.color_info_)
[1]:
1#1776D2

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_info_ = '#42F'
5print(settings.color_info_)
[2]:
1#42F

Better not to do that – 1 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_info_ = 1
5print(settings.color_info_)
[3]:
1#1776D2

– 2 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_info_ = ()
5print(settings.color_info_)
[4]:
1#1776D2
color_simple: str = '#666'

Plain text color (hexadecimal code)

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.color_simple, settings.color_simple_)
[1]:
1#666 #666

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_simple = '#666')
4print(settings.color_simple, settings.color_simple_)
[2]:
1#666 #666

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_simple = '#222')
4print(settings.color_simple, settings.color_simple_)
[3]:
1#222 #222

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_simple = 1)
4print(settings.color_simple, settings.color_simple_)
[4]:
1#666 #666

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_simple = {1, 2, 3})
4print(settings.color_simple, settings.color_simple_)
[5]:
1#666 #666
Type:

str

property color_simple_: str

Getting/setting plain text color

Parameters:

(str) – Hex code

Returns:

Hex code

Return type:

str

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_simple = '#111')
4print(settings.color_simple_)
[1]:
1#111

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_simple_ = '#444'
5print(settings.color_simple_)
[2]:
1#444

Better not to do that – 1 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_simple_ = 1
5print(settings.color_simple_)
[3]:
1#666

– 2 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_simple_ = ()
5print(settings.color_simple_)
[4]:
1#666
color_true: str = '#008001'

Text color containing positive information (hexadecimal code)

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.color_true, settings.color_true_)
[1]:
1#008001 #008001

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_true = '#003332')
4print(settings.color_true, settings.color_true_)
[2]:
1#003332 #003332

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_true = '#42F')
4print(settings.color_true, settings.color_true_)
[3]:
1#42F #42F

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_true = 1)
4print(settings.color_true, settings.color_true_)
[4]:
1#008001 #008001

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_true = [])
4print(settings.color_true, settings.color_true_)
[5]:
1#008001 #008001
Type:

str

property color_true_: str

Getting/setting the color of text containing positive information

Parameters:

(str) – Hex code

Returns:

Hex code

Return type:

str

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(color_true = '#008001')
4print(settings.color_true_)
[1]:
1#008001

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_true_ = '#42F'
5print(settings.color_true_)
[2]:
1#42F

Better not to do that – 1 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_true = 1
5print(settings.color_true)
[3]:
1#008001

– 2 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.color_true_ = ()
5print(settings.color_true_)
[4]:
1#008001
property ext_: List[str]

Getting/installing the extensions of searched files

Parameters:

(List[str]) – List with search file extensions

Returns:

List with search file extensions

Return type:

List[str]

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.ext_)
[1]:
1[]

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.ext_ = ['.mp4']
5print(settings.ext_)
[2]:
1['.mp4']

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.ext_ = ['.mp3', '.wav']
5print(settings.ext_)
[3]:
1['.mp3', '.wav']

– 4 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.ext_ = []
5print(settings.ext_)
[4]:
1[]

Better not to do that – 1 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.ext_ = [2, []]
5print(settings.ext_)
[5]:
1[]
property ignore_dirs_: List[str]

Getting/installing a list with directories not included in the selection

Parameters:

(List[str]) – List with directories

Returns:

List with directories

Return type:

List[str]

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.ignore_dirs_)
[1]:
1[]

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.ignore_dirs_ = ['test', 'test_2']
5print(settings.ignore_dirs_)
[2]:
1['test', 'test_2']

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.ignore_dirs_ = []
5print(settings.ignore_dirs_)
[3]:
1[]

– 4 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.ext_ = ['1_a', '2_b']
5print(settings.ext_)
[4]:
1['1_a', '2_b']

Better not to do that – 1 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.ignore_dirs_ = [2, []]
5print(settings.ignore_dirs_)
[5]:
1[]
property keys_dataset_

Getting/setting dataset key names

Parameters:

(List[str]) – List with dataset key names

Returns:

List with dataset key names

Return type:

List[str]

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.keys_dataset_)
[1]:
1[
2    'Path',
3    'Openness',
4    'Conscientiousness',
5    'Extraversion',
6    'Agreeableness',
7    'Non-Neuroticism'
8]

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.keys_dataset_ = ['P', 'O', 'C', 'E', 'A', 'N']
5print(settings.keys_dataset_)
[2]:
1['P', 'O', 'C', 'E', 'A', 'N']

Better not to do that – 1 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.keys_dataset_ = [{}, [], 1]
5print(settings.keys_dataset_)
[3]:
1[
2    'Path',
3    'Openness',
4    'Conscientiousness',
5    'Extraversion',
6    'Agreeableness',
7    'Non-Neuroticism'
8]

– 2 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.keys_dataset_ = ['P', 'O']
5print(settings.keys_dataset_)
[4]:
1[
2    'Path',
3    'Openness',
4    'Conscientiousness',
5    'Extraversion',
6    'Agreeableness',
7    'Non-Neuroticism'
8]

– 3 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.keys_dataset_ = []
5print(settings.keys_dataset_)
[5]:
1[
2    'Path',
3    'Openness',
4    'Conscientiousness',
5    'Extraversion',
6    'Agreeableness',
7    'Non-Neuroticism'
8]
num_to_df_display: int = 30

Number of rows to display in tables

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.num_to_df_display, settings.num_to_df_display_)
[1]:
130 30

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(num_to_df_display = 30)
4print(settings.num_to_df_display, settings.num_to_df_display_)
[2]:
130 30

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(num_to_df_display = 50)
4print(settings.num_to_df_display, settings.num_to_df_display_)
[3]:
150 50

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(num_to_df_display = 0)
4print(settings.num_to_df_display, settings.num_to_df_display_)
[4]:
130 30

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(num_to_df_display = 'some_text')
4print(settings.num_to_df_display, settings.num_to_df_display_)
[5]:
130 30
Type:

int

property num_to_df_display_: int

Getting/setting the number of rows to display in tables

Parameters:

(int) – Number of lines

Returns:

Number of lines

Return type:

int

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(num_to_df_display = 30)
4print(settings.num_to_df_display_)
[1]:
130

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.num_to_df_display_ = 50
5print(settings.num_to_df_display_)
[2]:
150

Better not to do that – 1 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.num_to_df_display_ = 0
5print(settings.num_to_df_display_)
[3]:
130

– 2 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.num_to_df_display_ = ()
5print(settings.num_to_df_display_)
[4]:
130
property path_to_dataset_: str

Getting/setting the dataset directory

Parameters:

(str) – Dataset directory

Returns:

Dataset directory

Return type:

str

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.path_to_dataset_)
[1]:
1.

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_dataset_ = './dataset'
5print(settings.path_to_dataset_)
[2]:
1dataset

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_dataset_ = ''
5print(settings.path_to_dataset_)
[3]:
1.

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_dataset_ = [2, []]
5print(settings.path_to_dataset_)
[4]:
1.

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_dataset_ = 1
5print(settings.path_to_dataset_)
[5]:
1.
property path_to_logs_: str

Getting/setting directory for saving LOG files

Parameters:

(str) – Directory for saving LOG files

Returns:

Directory for saving LOG files

Return type:

str

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.path_to_logs_)
[1]:
1logs

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_logs_ = './logs/DF'
5print(settings.path_to_logs_)
[2]:
1logs/DF

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_logs_ = ''
5print(settings.path_to_logs_)
[3]:
1.

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_logs_ = [2, []]
5print(settings.path_to_logs_)
[4]:
1logs

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_logs_ = {'a': 1, 'b': 2}
5print(settings.path_to_logs_)
[5]:
1logs
property path_to_save_: str

Getting/setting directory to save data

Parameters:

(str) – Directory for saving data

Returns:

Directory for saving data

Return type:

str

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4print(settings.path_to_save_)
[1]:
1models

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_save_ = './models/Audio'
5print(settings.path_to_save_)
[2]:
1models/Audio

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_save_ = ''
5print(settings.path_to_save_)
[3]:
1.

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_save_ = [2, []]
5print(settings.path_to_save_)
[4]:
1models

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings()
4settings.path_to_save_ = {'a': 1, 'b': 2}
5print(settings.path_to_save_)
[5]:
1models
text_runtime: str = ''

Runtime text

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en')
4print(settings.text_runtime, settings.text_runtime_)
[1]:
1Runtime Runtime

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', text_runtime = 'Code executed in')
4print(settings.text_runtime, settings.text_runtime_)
[2]:
1Code executed in Code executed in

– 3 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', text_runtime = 'Runtime')
4print(settings.text_runtime, settings.text_runtime_)
[3]:
1Runtime Runtime

Better not to do that – 1 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', text_runtime = 1)
4print(settings.text_runtime, settings.text_runtime_)
[4]:
1Runtime Runtime

– 2 –

In [5]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', text_runtime = {1, 2, 3})
4print(settings.text_runtime, settings.text_runtime_)
[5]:
1Runtime Runtime
Type:

str

property text_runtime_: str

Getting/setting the runtime text

Parameters:

(str) – Text

Returns:

Text

Return type:

str

Examples

True – 1 –

In [1]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en', text_runtime = 'Runtime')
4print(settings.text_runtime_)
[1]:
1Runtime

– 2 –

In [2]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en')
4settings.text_runtime_ = 'Code executed in'
5print(settings.text_runtime_)
[2]:
1Code executed in

Better not to do that – 1 –

In [3]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en')
4settings.text_runtime_ = 1
5print(settings.text_runtime_)
[3]:
1Runtime

– 2 –

In [4]:
1from oceanai.modules.core.settings import Settings
2
3settings = Settings(lang = 'en')
4settings.text_runtime_ = ()
5print(settings.text_runtime_)
[4]:
1Runtime