saucenao.saucenao

Complexity

Total Complexity

31

Size/Duplication

Total Lines	274
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	SauceNao.merge_results()	0	17	4
A	SauceNao.filter_results()	0	14	3
B	SauceNao.__init__()	0	32	1
A	SauceNao.merge_two_dicts()	0	11	1
B	SauceNao.check_image()	0	56	6
B	SauceNao.parse_results_html_to_json()	0	43	6
A	SauceNao.check_file()	0	20	2
A	SauceNao.parse_results_json()	0	10	3
B	SauceNao.get_content_value()	0	15	5

#!/usr/bin/python

This module should have a docstring.

# -*- coding: utf-8 -*-
import json
import logging
import os
import os.path
import re
import time
from mimetypes import MimeTypes
from typing import Generator

Unable to import 'typing'

Unused Generator imported from typing

import requests
from bs4 import BeautifulSoup as Soup
from bs4 import element

Unused element imported from bs4

from saucenao import http

try:
    from titlesearch import get_similar_titles

Found indentation with spaces instead of tabs

Unused get_similar_titles imported from titlesearch

except ImportError:
    get_similar_titles = None

Found indentation with spaces instead of tabs

from saucenao.exceptions import *

The usage of wildcard imports like saucenao.exceptions should generally be avoided.

InvalidOrWrongApiKeyException was imported with wildcard, but is not used.

DailyLimitReachedException was imported with wildcard, but is not used.

Imports from package saucenao are not grouped

class SauceNao(object):

Too many instance attributes (13/7)

The variable __class__ seems to be unused.

    """"

Found indentation with spaces instead of tabs

    small script to work with SauceNao locally
    """

    SEARCH_POST_URL = 'http://saucenao.com/search.php'

Found indentation with spaces instead of tabs

    # basic account allows currently 20 images within 30 seconds
    # you can increase this value is you have a premium account
    LIMIT_30_SECONDS = 20

Found indentation with spaces instead of tabs

    # 0=html, 2=json but json is omitting important data but includes more data about authors

This line is too long as per the coding-style (93/80).

    # taken from the API documentation(requires login): https://saucenao.com/user.php?page=search-api

This line is too long as per the coding-style (101/80).

    API_HTML_TYPE = 0

Found indentation with spaces instead of tabs

    API_JSON_TYPE = 2

Found indentation with spaces instead of tabs

    CONTENT_CATEGORY_KEY = 'Material'

Found indentation with spaces instead of tabs

    CONTENT_CHARACTERS_KEY = 'Characters'

Found indentation with spaces instead of tabs

    mime = None

Found indentation with spaces instead of tabs

    logger = None

Found indentation with spaces instead of tabs

    def __init__(self, directory, databases=999, minimum_similarity=65, combine_api_types=False, api_key=None,

This line is too long as per the coding-style (110/80).

Found indentation with spaces instead of tabs

Too many arguments (12/5)

                 exclude_categories='', move_to_categories=False, output_type=API_HTML_TYPE, start_file=None,

This line is too long as per the coding-style (109/80).

                 log_level=logging.ERROR, title_minimum_similarity=90):
        """Initializing function

Found indentation with spaces instead of tabs

        :type directory: str
        :type databases: int
        :type minimum_similarity: float
        :type combine_api_types: bool
        :type api_key: str
        :type exclude_categories: str
        :type move_to_categories: bool
        :type start_file: str
        :type log_level: int
        :type title_minimum_similarity: float
        """
        self._directory = directory

Found indentation with spaces instead of tabs

        self._databases = databases

Found indentation with spaces instead of tabs

        self._minimum_similarity = minimum_similarity

Found indentation with spaces instead of tabs

        self._combine_api_types = combine_api_types

Found indentation with spaces instead of tabs

        self._api_key = api_key

Found indentation with spaces instead of tabs

        self._exclude_categories = exclude_categories

Found indentation with spaces instead of tabs

        self._move_to_categories = move_to_categories

Found indentation with spaces instead of tabs

        self._output_type = output_type

Found indentation with spaces instead of tabs

        self._start_file = start_file

Found indentation with spaces instead of tabs

        self._title_minimum_similarity = title_minimum_similarity

Found indentation with spaces instead of tabs

        self._previous_status_code = None

Found indentation with spaces instead of tabs

        self.mime = MimeTypes()

Found indentation with spaces instead of tabs

        logging.basicConfig(level=log_level)

Found indentation with spaces instead of tabs

        self.logger = logging.getLogger("saucenao_logger")

Found indentation with spaces instead of tabs

    def check_file(self, file_name: str) -> list:

Found indentation with spaces instead of tabs

        """Check the given file for results on SauceNAO

Found indentation with spaces instead of tabs

        :type file_name: str
        :return:
        """
        self.logger.info("checking file: {0:s}".format(file_name))

Found indentation with spaces instead of tabs

        if self._combine_api_types:

Found indentation with spaces instead of tabs

            result = self.check_image(file_name, self.API_HTML_TYPE)

Found indentation with spaces instead of tabs

            sorted_results = self.parse_results_json(result)

Found indentation with spaces instead of tabs

            additional_result = self.check_image(file_name, self.API_JSON_TYPE)

Found indentation with spaces instead of tabs

            additional_sorted_results = self.parse_results_json(additional_result)

This line is too long as per the coding-style (82/80).

Found indentation with spaces instead of tabs

            sorted_results = self.merge_results(sorted_results, additional_sorted_results)

This line is too long as per the coding-style (90/80).

Found indentation with spaces instead of tabs

        else:

Found indentation with spaces instead of tabs

            result = self.check_image(file_name, self._output_type)

Found indentation with spaces instead of tabs

            sorted_results = self.parse_results_json(result)

Found indentation with spaces instead of tabs

        filtered_results = self.filter_results(sorted_results)

Found indentation with spaces instead of tabs

        return filtered_results

Found indentation with spaces instead of tabs

    def check_image(self, file_name: str, output_type: int) -> str:

Found indentation with spaces instead of tabs

        """Check the possible sources for the given file

Found indentation with spaces instead of tabs

        :type output_type: int
        :type file_name: str
        :return:
        """
        file_path = os.path.join(self._directory, file_name)

Found indentation with spaces instead of tabs

        files = {'file': open(file_path, 'rb').read()}

Found indentation with spaces instead of tabs

        headers = {

Found indentation with spaces instead of tabs

            'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) '

This line is too long as per the coding-style (109/80).

                          'Chrome/63.0.3239.84 Safari/537.36',
            'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8',

This line is too long as per the coding-style (110/80).

            'Accept-Language': 'en-DE,en-US;q=0.9,en;q=0.8',
            'Accept-Encoding': 'gzip, deflate, br',
            'DNT': '1',
            'Connection': 'keep-alive'
        }
        params = {

Found indentation with spaces instead of tabs

            'file': file_path,
            'Content-Type': self.mime.guess_type(file_path),
            # parameters taken from form on main page: https://saucenao.com/
            'url': None,
            'frame': 1,
            'hide': 0,
            # parameters taken from API documentation: https://saucenao.com/user.php?page=search-api

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

            'output_type': output_type,
            'db': self._databases,
        }

        if self._api_key:

Found indentation with spaces instead of tabs

            params['api_key'] = self._api_key

Found indentation with spaces instead of tabs

        link = requests.post(url=self.SEARCH_POST_URL, files=files, params=params, headers=headers)

This line is too long as per the coding-style (99/80).

Found indentation with spaces instead of tabs

        code, msg = http.verify_status_code(link, file_name)

Found indentation with spaces instead of tabs

        if code == http.STATUS_CODE_SKIP:

Found indentation with spaces instead of tabs

            self.logger.error(msg)

Found indentation with spaces instead of tabs

            return json.dumps({'results': []})

Found indentation with spaces instead of tabs

        elif code == http.STATUS_CODE_REPEAT:

Found indentation with spaces instead of tabs

            if not self._previous_status_code:

Found indentation with spaces instead of tabs

                self._previous_status_code = code

Found indentation with spaces instead of tabs

                self.logger.info("Received an unexpected status code, repeating after 10 seconds...")

This line is too long as per the coding-style (101/80).

Found indentation with spaces instead of tabs

                time.sleep(10)

Found indentation with spaces instead of tabs

                return self.check_image(file_name, output_type)

Found indentation with spaces instead of tabs

            else:

Found indentation with spaces instead of tabs

                raise UnknownStatusCodeException(msg)

Found indentation with spaces instead of tabs

The variable UnknownStatusCodeException does not seem to be defined.

        else:

Found indentation with spaces instead of tabs

            self._previous_status_code = None

Found indentation with spaces instead of tabs

        if output_type == self.API_HTML_TYPE:

Found indentation with spaces instead of tabs

            return self.parse_results_html_to_json(link.text)

Found indentation with spaces instead of tabs

        return link.text

Found indentation with spaces instead of tabs

    @staticmethod

Found indentation with spaces instead of tabs

    def parse_results_html_to_json(html: str) -> str:

Found indentation with spaces instead of tabs

        """Parse the results and sort them descending by similarity

Found indentation with spaces instead of tabs

        :type html: str
        :return:
        """
        soup = Soup(html, 'html.parser')

Found indentation with spaces instead of tabs

        # basic format of json API response
        results = {'header': {}, 'results': []}

Found indentation with spaces instead of tabs

        for res in soup.find_all('td', attrs={"class": "resulttablecontent"}):  # type: element.Tag

This line is too long as per the coding-style (99/80).

Found indentation with spaces instead of tabs

            # optional field in SauceNao
            title_tag = res.find_next('div', attrs={"class": "resulttitle"})

Found indentation with spaces instead of tabs

            if title_tag:

Found indentation with spaces instead of tabs

                title = title_tag.text

Found indentation with spaces instead of tabs

            else:

Found indentation with spaces instead of tabs

                title = ''

Found indentation with spaces instead of tabs

            # mandatory field in SauceNao
            similarity = res.find_next('div', attrs={"class": "resultsimilarityinfo"}).text.replace('%', '')

This line is too long as per the coding-style (108/80).

Found indentation with spaces instead of tabs

            alternate_links = [a_tag['href'] for a_tag in

Found indentation with spaces instead of tabs

                               res.find_next('div', attrs={"class": "resultmiscinfo"}).find_all('a', href=True)]

This line is too long as per the coding-style (112/80).

            content_column = []

Found indentation with spaces instead of tabs

            content_column_tags = res.find_all('div', attrs={"class": "resultcontentcolumn"})

This line is too long as per the coding-style (93/80).

Found indentation with spaces instead of tabs

            for content_column_tag in content_column_tags:

Found indentation with spaces instead of tabs

                for br in content_column_tag.find_all('br'):

Found indentation with spaces instead of tabs

The name br does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

                    br.replace_with('\n')

Found indentation with spaces instead of tabs

                content_column.append(content_column_tag.text)

Found indentation with spaces instead of tabs

            result = {

Found indentation with spaces instead of tabs

                'header': {
                    'similarity': similarity
                },
                'data': {
                    'title': title,
                    'content': content_column,
                    'ext_urls': alternate_links
                }
            }
            results['results'].append(result)

Found indentation with spaces instead of tabs

        return json.dumps(results)

Found indentation with spaces instead of tabs

    @staticmethod

Found indentation with spaces instead of tabs

    def parse_results_json(text: str) -> list:

Found indentation with spaces instead of tabs

        """Parse the results and sort them descending by similarity

Found indentation with spaces instead of tabs

        :type text: str
        :return:
        """
        result = json.loads(text)

Found indentation with spaces instead of tabs

        results = [res for res in result['results']]

Found indentation with spaces instead of tabs

        return sorted(results, key=lambda k: float(k['header']['similarity']), reverse=True)

This line is too long as per the coding-style (92/80).

Found indentation with spaces instead of tabs

    def filter_results(self, sorted_results) -> list:

Found indentation with spaces instead of tabs

        """Return results with a similarity bigger or the same as the defined similarity from the arguments (default 65%)

This line is too long as per the coding-style (121/80).

Found indentation with spaces instead of tabs

        :type sorted_results: list|tuple|Generator
        :return:
        """
        filtered_results = []

Found indentation with spaces instead of tabs

        for res in sorted_results:

Found indentation with spaces instead of tabs

            if float(res['header']['similarity']) >= float(self._minimum_similarity):

This line is too long as per the coding-style (85/80).

Found indentation with spaces instead of tabs

                filtered_results.append(res)

Found indentation with spaces instead of tabs

            else:

Found indentation with spaces instead of tabs

                # we can break here since the results are sorted by similarity anyways

This line is too long as per the coding-style (86/80).

                break

Found indentation with spaces instead of tabs

        return filtered_results

Found indentation with spaces instead of tabs

    @staticmethod

Found indentation with spaces instead of tabs

    def get_content_value(results, key: str):

Found indentation with spaces instead of tabs

        """Return the first match of Material in content

Found indentation with spaces instead of tabs

        multiple sites have a categorisation which SauceNao utilizes to provide it in the content section

This line is too long as per the coding-style (105/80).

        :type results: list|tuple|Generator
        :type key: str
        :return:
        """
        for result in results:

Found indentation with spaces instead of tabs

            if 'content' in list(result['data'].keys()):

Found indentation with spaces instead of tabs

                for content in result['data']['content']:

Found indentation with spaces instead of tabs

                    if re.match('{0:s}: .*'.format(key), content):

Found indentation with spaces instead of tabs

                        return ''.join(re.split(r'{0:s}: '.format(key), content)[1:]).rstrip("\n").split('\n')

This line is too long as per the coding-style (110/80).

Found indentation with spaces instead of tabs

        return ''

Found indentation with spaces instead of tabs

    @staticmethod

Found indentation with spaces instead of tabs

    def merge_two_dicts(x: dict, y: dict) -> dict:

Found indentation with spaces instead of tabs

The name x does not conform to the argument naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

The name y does not conform to the argument naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        """Take x dictionary and insert/overwrite y dictionary values

Found indentation with spaces instead of tabs

        :type x: dict
        :type y: dict
        :return:
        """
        z = x.copy()

Found indentation with spaces instead of tabs

The name z does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        z.update(y)

Found indentation with spaces instead of tabs

        return z

Found indentation with spaces instead of tabs

    def merge_results(self, result: list, additional_result: list) -> list:

Found indentation with spaces instead of tabs

        """Merge two result arrays

Found indentation with spaces instead of tabs

        :type result: list
        :type additional_result: list
        :return:
        """
        if len(result) <= len(additional_result):

Found indentation with spaces instead of tabs

            length = len(result)

Found indentation with spaces instead of tabs

        else:

Found indentation with spaces instead of tabs

            length = len(additional_result)

Found indentation with spaces instead of tabs

        for i in range(length):

Found indentation with spaces instead of tabs

            for key in list(result[i].keys()):

Found indentation with spaces instead of tabs

                result[i][key] = self.merge_two_dicts(result[i][key], additional_result[i][key])

This line is too long as per the coding-style (96/80).

Found indentation with spaces instead of tabs

        return result

Found indentation with spaces instead of tabs