Pipeline.to_yaml() - Code Metrics - richlewis42/scikit-chem - Measure and Improve Code Quality continuously with Scrutinizer

Pipeline.to_yaml() A
last analyzed 2016-09-01 14:43 UTC

↳ Parent: Pipeline

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1.125

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	14
ccs	1
cts	2
cp	0.5
rs	9.4285
cc	1
crap	1.125

#! /usr/bin/env python
#
# Copyright (C) 2015-2016 Rich Lewis <[email protected]>
# License: 3-clause BSD

"""
# skchem.pipeline.pipeline

Module implementing pipelines.
"""

from ..utils import yaml_dump, json_dump
from ..io import read_config, read_json, read_yaml



def is_transform_filter(obj):
    """ Whether an object is a TransformFilter (by duck typing). """
    return hasattr(obj, 'transform_filter')


def is_filter(obj):
    """ Whether an object is a Filter (by duck typing). """
    return hasattr(obj, 'filter')


def is_transformer(obj):
    """ Whether an object is a Transformer (by duck typing). """
    return hasattr(obj, 'transform')


class Pipeline(object):

    """ Pipeline object. Applies filters and transformers in sequence. """

    def __init__(self, objects):
        self.objects = objects

    def get_params(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return {'objects': [obj.to_dict() for obj in self.objects]}

    def to_dict(self):
        """ Return a dictionary representation of the object."""

        return {'skchem.pipeline.pipeline.Pipeline': self.get_params()}

    @classmethod
    def from_params(cls, params):
        """ Create a instance from a params dictionary. """
        return cls([read_config(conf) for conf in params['objects']])

    def to_json(self, target=None):

        """ Serialize the object as JSON.

        Args:
            target (str or file-like):
                A file or filepath to serialize the object to.  If `None`,
                return the JSON as a string.

            Returns:
                None or str
        """

        return json_dump(self.to_dict(), target)

    def to_yaml(self, target=None):

        """ Serialize the object as YAML.

        Args:
            target (str or file-like):
                A file or filepath to serialize the object to.  If `None`,
                return the YAML as a string.

            Returns:
                None or str
        """

        return yaml_dump(self.to_dict(), target)

    def copy(self):
        """ Return a copy of this object. """
        return self.__class__(self.get_params())

    def transform_filter(self, mols, y=None):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        for obj in self.objects:
            if is_transform_filter(obj):
                mols = obj.transform_filter(mols)
            elif is_filter(obj):
                mols = obj.filter(mols)
            elif is_transformer(obj):
                mols = obj.transform(mols)
            else:
                raise NotImplementedError('Cannot apply {}.'.format(obj))
        return mols if y is None else (mols, y.reindex(mols.index))



1		#! /usr/bin/env python
2		#
3		# Copyright (C) 2015-2016 Rich Lewis <[email protected]>
4		# License: 3-clause BSD
5
6	1	"""
7		# skchem.pipeline.pipeline
8
9		Module implementing pipelines.
10		"""
11
12	1	from ..utils import yaml_dump, json_dump
13	1	from ..io import read_config, read_json, read_yaml
		0 ignored issues – show Unused Code introduced 2016-08-18 20:05 UTC by Report Bug Copy Issue Report Unused read_json imported from io Loading history... Unused Code introduced 2016-08-18 20:05 UTC by Report Bug Copy Issue Report Unused read_yaml imported from io Loading history...
14
15
16	1	def is_transform_filter(obj):
17		""" Whether an object is a TransformFilter (by duck typing). """
18		return hasattr(obj, 'transform_filter')
19
20
21	1	def is_filter(obj):
22		""" Whether an object is a Filter (by duck typing). """
23		return hasattr(obj, 'filter')
24
25
26	1	def is_transformer(obj):
27		""" Whether an object is a Transformer (by duck typing). """
28		return hasattr(obj, 'transform')
29
30
31	1	class Pipeline(object):
32
33		""" Pipeline object. Applies filters and transformers in sequence. """
34
35	1	def __init__(self, objects):
36		self.objects = objects
37
38	1	def get_params(self):
		0 ignored issues – show Coding Style introduced 2016-08-18 20:05 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...
39		return {'objects': [obj.to_dict() for obj in self.objects]}
40
41	1	def to_dict(self):
42		""" Return a dictionary representation of the object."""
43
44		return {'skchem.pipeline.pipeline.Pipeline': self.get_params()}
45
46	1	@classmethod
47		def from_params(cls, params):
48		""" Create a instance from a params dictionary. """
49		return cls([read_config(conf) for conf in params['objects']])
50
51	1	def to_json(self, target=None):
52
53		""" Serialize the object as JSON.
54
55		Args:
56		target (str or file-like):
57		A file or filepath to serialize the object to. If `None`,
58		return the JSON as a string.
59
60		Returns:
61		None or str
62		"""
63
64		return json_dump(self.to_dict(), target)
65
66	1	def to_yaml(self, target=None):
67
68		""" Serialize the object as YAML.
69
70		Args:
71		target (str or file-like):
72		A file or filepath to serialize the object to. If `None`,
73		return the YAML as a string.
74
75		Returns:
76		None or str
77		"""
78
79		return yaml_dump(self.to_dict(), target)
80
81	1	def copy(self):
82		""" Return a copy of this object. """
83		return self.__class__(self.get_params())
84
85	1	def transform_filter(self, mols, y=None):
		0 ignored issues – show Coding Style Naming introduced 2016-08-05 16:20 UTC by Report Bug Copy Issue Report The name `y` does not conform to the argument 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... Coding Style introduced 2016-08-05 16:20 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...
86		for obj in self.objects:
87		if is_transform_filter(obj):
88		mols = obj.transform_filter(mols)
89		elif is_filter(obj):
90		mols = obj.filter(mols)
91		elif is_transformer(obj):
92		mols = obj.transform(mols)
93		else:
94		raise NotImplementedError('Cannot apply {}.'.format(obj))
95		return mols if y is None else (mols, y.reindex(mols.index))
96
97

richlewis42 / scikit-chem

Pipeline.to_yaml() A last analyzed 2016-09-01 14:43 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Pipeline.to_yaml() A
last analyzed 2016-09-01 14:43 UTC