1'''
  2# Subpackage utilities
  3
  4The utility package is designed to contain source code that is used in the library on a recurring basis, and whose functionality is to provide a certain utility to the library.
  5
  6## Module structure
  7
  8**Package structure**
  9
 10```bash
 11../../olivia_finder/olivia_finder/utilities
 12├── config.py
 13├── exception.py
 14├── __init__.py
 15├── logger.py
 16├── singleton_decorator.py
 17└── utilities.py
 18```
 19
 20
 21## Module `utilities.config`
 22
 23
 24Provides the configuration class, which is used to obtain the configuration variables defined in the .ini configuration file
 25
 26.. warning::
 27
 28    It is a Singleton instance so only one instance is accessible from any part of the code through the constructor
 29
 30    
 31
 32
 33
 34```python
 35from olivia_finder.utilities.config import Configuration
 36```
 37
 38You need to provide a configuration file
 39
 40The configuration file is located in the root of the olivia_finder package
 41
 42In this execution we are using a personalized configuration file for demonstration
 43
 44
 45```python
 46!cat ./config.ini
 47```
 48
 49    [olivia_finder_logger]
 50    ; Levels: DEBUG, INFO, WARNING, ERROR, CRITICAL
 51    name                     = olivia_finder
 52    level                    = DEBUG
 53    status                   = ENABLED
 54    file_handler             = ENABLED
 55    console_handler          = ENABLED
 56    
 57    ; Myrequests configuration
 58    [logger_myrequests]
 59    name                 = olivia_finder.myrequests
 60    level                = DEBUG
 61    status               = DISABLED
 62    file_handler         = DISABLED
 63    console_handler      = DISABLED
 64    
 65    ; Package Manager configuration
 66    [logger_packagemanager]
 67    name                 = olivia_finder.packagemanager
 68    level                = DEBUG
 69    status               = DISABLED
 70    file_handler         = DISABLED
 71    console_handler      = DISABLED
 72    
 73    ; CSV Datasource configuration
 74    [logger_datasource]
 75    name                 = olivia_finder.datasource
 76    level                = DEBUG
 77    status               = DISABLED
 78    file_handler         = DISABLED
 79    console_handler      = DISABLED
 80    
 81    ; Output directory for the results
 82    [folders]
 83    logger                      = logs/
 84    working_dir                 = results/working/
 85    
 86    
 87    ; Libraries.io configuration
 88    [librariesio]
 89    api_key                     = 558f419425861e607e78cd4e3a0b129b
 90
 91Acess the keys using `get_key` method
 92
 93
 94```python
 95Configuration().get_key('olivia_finder_logger', 'status')
 96``
 97    'ENABLED'
 98
 99
100## Module `utilities.logger`
101
102
103
104```python
105from olivia_finder.utilities.logger import MyLogger
106```
107
108The class MyLogger implements an utility loging tools to register the actions of execution. It is based on the default Python logging module
109
110
111```python
112
113logger = MyLogger.get_logger("olivia_finder_logger")
114
115logger.debug('Debug message')
116logger.info('Info message')
117logger.warning('Warning message')
118logger.error('Error message')
119logger.critical('Critical message')
120
121# Acess the logger using the default logging class
122import logging
123logging.getLogger(logger.name).debug('Debug message')
124```
125
126    2023-06-28 19:26:34,316 [olivia_finder(DEBUG)] -> 4423775.py:3
127    Debug message
128    2023-06-28 19:26:34,318 [olivia_finder(INFO)] -> 4423775.py:4
129    Info message
130    2023-06-28 19:26:34,318 [olivia_finder(WARNING)] -> 4423775.py:5
131    Warning message
132    2023-06-28 19:26:34,319 [olivia_finder(ERROR)] -> 4423775.py:6
133    Error message
134    2023-06-28 19:26:34,319 [olivia_finder(CRITICAL)] -> 4423775.py:7
135    Critical message
136    2023-06-28 19:26:34,320 [olivia_finder(DEBUG)] -> 4423775.py:10
137    Debug message
138    2023-06-28 19:26:34,320 [olivia_finder(DEBUG)] -> 4423775.py:14
139    Debug message
140
141
142Default logger is root
143
144
145```python
146# The default logger is root and it is not configured
147MyLogger.get_logger().debug('Debug message')
148MyLogger.get_logger().info('Info message')
149MyLogger.get_logger().warning('Warning message')
150MyLogger.get_logger().error('Error message')
151MyLogger.get_logger().critical('Critical message')
152```
153    Warning message
154    Error message
155    Critical message
156
157Change log level
158
159
160```python
161MyLogger.configure_level("olivia_finder_logger", 'console', 'warning')
162logger = MyLogger.get_logger("olivia_finder_logger")
163logger.debug('Debug message')
164logger.info('Info message')
165logger.warning('Warning message')
166logger.error('Error message')
167logger.critical('Critical message')
168```
169
170    2023-06-28 19:26:34,331 [olivia_finder(WARNING)] -> 446635553.py:4
171    Warning message
172    2023-06-28 19:26:34,332 [olivia_finder(ERROR)] -> 446635553.py:5
173    Error message
174    2023-06-28 19:26:34,333 [olivia_finder(CRITICAL)] -> 446635553.py:6
175    Critical message
176
177## Module `utilities.exceptions`
178
179Includes a series of exceptions to be used by the library and provide a more generic context in the case of being rised
180
181
182```python
183from olivia_finder.utilities.exception import OliviaFinderException
184```
185
186
187```python
188OliviaFinderException('Test exception')
189```
190    OliviaFinderException: Test exception
191
192
193
194## Module `utilities.singleton_decorator`
195
196This module includes a decorator-based implementation of the Singleton design pattern
197
198
199```python
200from olivia_finder.utilities.singleton_decorator import singleton
201```
202
203
204```python
205# Dummy class
206@singleton
207class Dummy:
208    def __init__(self, name):
209        self.name = name
210```
211
212
213```python
214print(Dummy('test').name)
215print(Dummy('test2').name)
216```
217
218    test
219    test
220
221
222## Module `utilities.utilities`
223
224A module containing common source code to be reused
225
226'''