MohammadForouhesh / crf-pos-persian

crf_pos/api.py

"""
API

....................................................................................................
MIT License

Copyright (c) 2021-2023 AUT Iran, Mohammad H Forouhesh
Copyright (c) 2021-2022 MetoData.ai, Mohammad H Forouhesh
....................................................................................................
This module contains tools to download resources over http connections.
supported http links are:
    - https://github.com/MohammadForouhesh/crf-pos-persian/releases/download/v2.0.0.alpha/UPC_full_model_wapiti

This line is too long as per the coding-style (111/100).

    - https://github.com/MohammadForouhesh/crf-pos-persian/releases/download/v2.0.0.alpha/perpos.model

This line is too long as per the coding-style (102/100).

    - https://raw.githubusercontent.com/MohammadForouhesh/crf-pos-persian/main/resources/corrections.txt

This line is too long as per the coding-style (104/100).

"""

import os
from typing import Union

import requests

http_dict = {'UPC_full_model_wapiti': 'https://github.com/MohammadForouhesh/crf-pos-persian/releases/download/v.2.2.2/UPC_full_model_wapiti',

This line is too long as per the coding-style (141/100).

             'perpos.model': 'https://github.com/MohammadForouhesh/crf-pos-persian/releases/download/v.2.2.2/perpos.model',

This line is too long as per the coding-style (123/100).

             'corrections.txt': 'https://raw.githubusercontent.com/MohammadForouhesh/crf-pos-persian/main/resources/corrections.txt'}

This line is too long as per the coding-style (133/100).

def downloader(path: str, save_path: str, mode: str) -> Union[int, None]:

Either all return statements in a function should return an expression, or none of them should.

    """
    A tool to download and save files over https.
    supported http links are:
    - https://github.com/MohammadForouhesh/crf-pos-persian/releases/download/v2.0.0.alpha/UPC_full_model_wapiti

This line is too long as per the coding-style (111/100).

    - https://github.com/MohammadForouhesh/crf-pos-persian/releases/download/v.2.2.2/perpos.model
    - https://raw.githubusercontent.com/MohammadForouhesh/crf-pos-persian/main/resources/corrections.txt

This line is too long as per the coding-style (104/100).

    :param path:        The path to the desired file.
    :param save_path:   The intended storage path.
    :param mode:        The mode that it should be stored.
    :return:            If the file exists, it returns 0 (int), otherwise nothing would be returned.
    """
    if os.path.isfile(save_path): return 0

More than one statement on a single line

    try:
        print('Downloading resources ...')
        model_bin = requests.get(path, allow_redirects=True)
        with open(save_path, mode) as resource:
            resource.write(model_bin.content)
    except Exception as e:

Variable name "e" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        raise e.with_traceback

Raising with_traceback while only classes or instances are allowed

def get_resources(dir_path: str, resource_name: str) -> str:
    """
    A tool to download required resources over internet.
    :param dir_path:        Path to the https link of the resource
    :param resource_name:   Resource name.
    :return:                Path to the downloaded resource.
    """
    save_dir = dir_path + 'resources/'
    os.makedirs(save_dir, exist_ok=True)
    downloader(path=http_dict[resource_name], save_path=save_dir + resource_name, mode='wb')
    return str(save_dir + resource_name)