"""
This file contains the logic for South African ID book (post 1994)
context.
"""
from hutts_verification.id_contexts.id_context import FieldType, LineType
from hutts_verification.id_contexts.sa_id import SAID
from hutts_verification.utils.hutts_logger import logger
from fuzzywuzzy import fuzz
__author__ = "Jan-Justin van Tonder"
__copyright__ = "Copyright 2017, Java the Hutts"
__license__ = "BSD"
__maintainer__ = "Jan-Justin van Tonder"
__email__ = "J.vanTonder@tuks.co.za"
__status__ = "Development"
[docs]class SAIDBook(SAID):
"""
A class that represents an ID context for a South African ID book (post 1994).
It supplies some of the concrete information, such as the match contexts, to the classes higher up in inheritance
hierarchy and implements abstract methods defined by its parent.
"""
def __init__(self):
"""
Initialises the SAIDBook object.
"""
# Logging for debugging purposes.
logger.debug('Initialising %s...' % type(self).__name__)
# Specify initial list of contexts for string image_processing when populating
# the ID information dictionary to send as output.
match_contexts = [{
'field': 'identity_number',
'find': 'id no',
'field_type': FieldType.NUMERIC_ONLY,
'line_type': LineType.TITLED_ADJACENT,
'multi_line': False
}, {
'field': 'surname',
'find': 'surname',
'field_type': FieldType.TEXT_ONLY,
'to_uppercase': False,
'line_type': LineType.TITLED_NEWLINE,
'multi_line': True,
'multi_line_end': 'forenames'
}, {
'field': 'names',
'find': 'forenames',
'field_type': FieldType.TEXT_ONLY,
'to_uppercase': False,
'line_type': LineType.TITLED_NEWLINE,
'multi_line': True,
'multi_line_end': 'country of birth'
}, {
'field': 'sex',
'find': 'sex',
'field_type': FieldType.TEXT_ONLY,
'to_uppercase': False,
'line_type': LineType.TITLED_NEWLINE,
'multi_line': False
}, {
'field': 'date_of_birth',
'find': 'date of birth',
'field_type': FieldType.DATE_HYPHENATED,
'to_uppercase': False,
'line_type': LineType.TITLED_NEWLINE,
'multi_line': False
}, {
'field': 'country_of_birth',
'find': 'country of birth',
'field_type': FieldType.TEXT_ONLY,
'to_uppercase': False,
'line_type': LineType.TITLED_NEWLINE,
'multi_line': False
}, {
'field': 'status',
'find': 'sacitizen',
'field_type': FieldType.TEXT_ONLY,
'to_uppercase': False,
'line_type': LineType.UNTITLED_ADJACENT,
'multi_line': False
}]
# Initialise parent
SAID.__init__(self, match_contexts)
def _get_idiosyncratic_match(self, match_context, id_string_list, current_index):
"""
Identifies and returns matches that are specific to the current ID context.
:param match_context (dict): A dictionary object that provides context for
the information that is to be extracted.
:param id_string_list (list): An ID string that has been broken down into
a list of individual lines.
:param current_index (int): The current index within the ID string list.
Returns:
- (str): A string containing the match value of a context-specific case.
- (None): Used to indicate that no special case was identified.
"""
# Check for the status special case.
if match_context['field'] == 'status':
citizen_match_ratio = fuzz.token_set_ratio(id_string_list[current_index], 'sacitizen')
non_citizen_match_ratio = fuzz.token_set_ratio(id_string_list[current_index], 'nonsacitizen')
match = 'Citizen' if citizen_match_ratio > non_citizen_match_ratio else 'Non Citizen'
return match
# Otherwise return an empty string to indicate that a special case was not identified.
return None