OutputInterface.save() - Code Metrics - Inspection of "Merge pull request #77 from brianrusso/master" - ContinuumIO/topik - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 980041...30b693 )

unknown

created 2016-04-20 21:21 UTC

OutputInterface.save() A

↳ Parent: OutputInterface

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	11
rs	9.4285
cc	2

from abc import ABCMeta, abstractmethod
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

from six import with_metaclass
import jsonpickle

from ._registry import registered_outputs


class OutputInterface(with_metaclass(ABCMeta)):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    def __init__(self, *args, **kwargs):
        super(OutputInterface, self).__init__( *args, **kwargs)

        # should be an iterable with each member having (id, text)
        self.corpus = None
        # should be a dictionary-like structure, with string ids for tokenizer used and parameters
        #     passed and dictionaries mapping doc id to list of tokens
        self.tokenized_corpora = None
        # should be a dictionary-like structure, with string ids for vectorizer used and parameters
        #     passed and dictionaries mapping doc id to list of tokens
        self.vectorized_corpora = None
        # should be a dictionary-like structure, with string ids for model used and parameters passed
        #     and dictionaries mapping doc id to list of tokens
        self.modeled_corpora = None

    def save(self, filename, saved_data=None):
        """Persist this object to disk somehow.

        You can save your data in any number of files in any format, but at a minimum, you need one json file that
        describes enough to bootstrap the loading process.  Namely, you must have a key called 'class' so that upon
        loading the output, the correct class can be instantiated and used to load any other data.  You don't have
        to implement anything for saved_data, but it is stored as a key next to 'class'.

        """
        with open(filename, "w") as f:

            f.write(jsonpickle.encode({"class": self.__class__.__name__, "saved_data": saved_data}, f))

    def synchronize(self, max_wait, field):
        """By default, operations are synchronous and no additional wait is
        necessary.  Data sources that are asynchronous (ElasticSearch) may
        use this function to wait for "eventual consistency" """
        pass

    @abstractmethod
    def get_filtered_data(self, field_to_get, filter=""):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        raise NotImplementedError

    def close(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        pass


def load_output(filename):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    with open(filename) as f:

        output_details = jsonpickle.decode(f.read())
    return registered_outputs[output_details['class']](**output_details["saved_data"])


1			from abc import ABCMeta, abstractmethod
			0 ignored issues – show Coding Style introduced 2015-11-23 14:50 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2
3			from six import with_metaclass
4			import jsonpickle
5
6			from ._registry import registered_outputs
7
8
9			class OutputInterface(with_metaclass(ABCMeta)):
			0 ignored issues – show Coding Style introduced 2015-11-23 14:50 UTC by Report Bug Copy Issue Report This class should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
10			def __init__(self, args, *kwargs):
11			super(OutputInterface, self).__init__( args, *kwargs)
			0 ignored issues – show Coding Style introduced 2015-11-23 14:50 UTC by Report Bug Copy Issue Report No space allowed after bracket super(OutputInterface, self).__init__( args, *kwargs) ^ Loading history...
12			# should be an iterable with each member having (id, text)
13			self.corpus = None
14			# should be a dictionary-like structure, with string ids for tokenizer used and parameters
15			# passed and dictionaries mapping doc id to list of tokens
16			self.tokenized_corpora = None
17			# should be a dictionary-like structure, with string ids for vectorizer used and parameters
18			# passed and dictionaries mapping doc id to list of tokens
19			self.vectorized_corpora = None
20			# should be a dictionary-like structure, with string ids for model used and parameters passed
21			# and dictionaries mapping doc id to list of tokens
22			self.modeled_corpora = None
23
24			def save(self, filename, saved_data=None):
25			"""Persist this object to disk somehow.
26
27			You can save your data in any number of files in any format, but at a minimum, you need one json file that
28			describes enough to bootstrap the loading process. Namely, you must have a key called 'class' so that upon
29			loading the output, the correct class can be instantiated and used to load any other data. You don't have
30			to implement anything for saved_data, but it is stored as a key next to 'class'.
31
32			"""
33			with open(filename, "w") as f:
			0 ignored issues – show Coding Style Naming introduced 2015-11-23 14:50 UTC by Report Bug Copy Issue Report The name `f` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
34			f.write(jsonpickle.encode({"class": self.__class__.__name__, "saved_data": saved_data}, f))
35
36			def synchronize(self, max_wait, field):
37			"""By default, operations are synchronous and no additional wait is
38			necessary. Data sources that are asynchronous (ElasticSearch) may
39			use this function to wait for "eventual consistency" """
40			pass
41
42			@abstractmethod
43			def get_filtered_data(self, field_to_get, filter=""):
			0 ignored issues – show Bug Best Practice introduced 2015-11-23 14:50 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `filter`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history... Coding Style introduced 2015-11-23 14:50 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
44			raise NotImplementedError
45
46			def close(self):
			0 ignored issues – show Coding Style introduced 2015-11-23 14:50 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
47			pass
48
49
50			def load_output(filename):
			0 ignored issues – show Coding Style introduced 2015-11-23 14:50 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
51			with open(filename) as f:
			0 ignored issues – show Coding Style Naming introduced 2015-11-23 14:50 UTC by Report Bug Copy Issue Report The name `f` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
52			output_details = jsonpickle.decode(f.read())
53			return registered_outputs[output_details['class']](**output_details["saved_data"])
54

ContinuumIO / topik

Push — master ( 980041...30b693 )

OutputInterface.save() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like