corporateStat.py

#!/usr/bin/python3

from __future__ import annotations
from datetime import date
from csv import reader as csvReader

'''
    This class is expected to hold data for a certain company registered
    under some RoC

    What we mostly do is, we read from CSV data file ( which is actually source dataset ),
    & convert that into python objects, in hope that it'll be easier for us to use that
    formatted, structured & objectified data.
'''


class Company:
    def __init__(self, cin: str, name: str, status: str, companyClass: str, category: str, subCategory: str, dor: str, state: str, authorizedCap: str, paidUpCap: str, industrialClass: str, businessActivity: str, address: str, roc: str, email: str):
        self.corporateIdentificationNumber = cin
        self.name = name
        self.status = status
        self.companyClass = companyClass
        self.category = category
        self.subCategory = subCategory
        self._dateOfRegistration = dor
        self.registeredState = state
        self.authorizedCapital = authorizedCap
        self.paidUpCapital = paidUpCap
        self.industrialClass = industrialClass
        self.principalBusinessActivity = businessActivity
        self.registeredOfficeAddress = address
        self.registrarOfCompanies = roc
        self.email = email

    def __str__(self):
        super().__str__()
        return '{} -- {} -- {}'.format(self.name, self.status, self.dateOfRegistration)

    '''
        this property is expected to convert dateOfRegistration of this company
        from string to an instance of Date class ( which makes manipulation of Date easier)
    '''
    @property
    def dateOfRegistration(self) -> date:
        try:
            return date(*[int(i) for i in self._dateOfRegistration.split('-')[-1::-1]])
        except Exception:
            return None


'''
    Designed to hold a stream ( generating all companies, one time subscription ) 
    present under one certain State of India
    
    State, about which we're currently talking, can also be looked up from an instance of this class
'''


class CompaniesUnderState:
    def __init__(self, state: str, companies):
        self.state = state
        self.companies = companies

    '''
        This static method is expected to read from a CSV data file ( holding information about a certain State ),
        and create an instance of this class, holding all data present in CSV file, in objectified form, so manipulating it
        becomes easier
    '''
    @staticmethod
    def importFromCSV(state: str, targetPath: str) -> CompaniesUnderState:
        '''
            CSV dataset to be processed is pretty malformed like
            we can't just use `,` ( comma ) as field seperator in CSV.

            Cause there's `,` ( comma ) present in unexpected places, so
            what we're going to handle that using python's very own `csv` module,
            while using `excel` as dialect.
        '''

        companiesUnderStateObject = None  # this is what's to be returned
        try:
            # reads CSV file content in splitted line form,
            # which is to be processed for creating an instance of Company class
            with open(targetPath, mode='r', encoding='ISO-8859-1') as fd:
                companiesUnderStateObject = CompaniesUnderState(
                    state, (Company(*i[:-2]) for i in csvReader(fd.readlines()[1:])))
        except Exception:
            companiesUnderStateObject = None
        finally:
            return companiesUnderStateObject


if __name__ == '__main__':
    print('[!]This module is designed to be used as a backend handler')
    exit(0)