method_takes_pandas() - Code Metrics - Inspection of "changed testing to py.test" - richlewis42/scikit-chem - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 97f98d...9ca1ad )

by Rich

created 2016-06-30 13:42 UTC

method_takes_pandas() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	3

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


"""
# skchem.utils.decorators

Decorators for skchem functions.
"""

import pandas as pd
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from functools import wraps

from .. import core

def takes_mol_series(func):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    @wraps(func)
    @takes_pandas
    def inner(inp, *args, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        if isinstance(inp, pd.DataFrame):
            inp = inp.structure
        return func(inp, *args, **kwargs)
    return inner

def method_takes_mol_series(func):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    @wraps(func)
    def inner(self, *args, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return takes_mol_series(lambda *args, **kwargs: func(self, *args, **kwargs))(*args, **kwargs)

    return inner

def takes_pandas(func):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    @wraps(func)
    def inner(inp, *args, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        single = False
        if isinstance(inp, core.Mol):
            single = True
            inp = pd.Series({inp.name: inp})
        elif isinstance(inp, (list, tuple)):
            inp = pd.Series(inp, index=[mol.name for mol in inp])
        elif isinstance(inp, dict):
            inp = pd.Series(inp)
        elif isinstance(inp, (pd.Series, pd.DataFrame)):
            pass
        else:
            raise NotImplementedError('{} cannot take object of type: {}'.format(func.__name__, type(inp)))

        res = func(inp, *args, **kwargs)
        if single:
            return res.iloc[0]
        else:
            return res
    return inner

def method_takes_pandas(func):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    @wraps(func)
    def inner(self, *args, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return takes_pandas(lambda *args, **kwargs: func(self, *args, **kwargs))(*args, **kwargs)

    return inner


1			#! /usr/bin/env python
2			#
3			# Copyright (C) 2016 Rich Lewis <[email protected]>
4			# License: 3-clause BSD
5
6
7			"""
8			# skchem.utils.decorators
9
10			Decorators for skchem functions.
11			"""
12
13			import pandas as pd
			0 ignored issues – show Configuration introduced 2016-06-30 13:44 UTC by Report Bug Copy Issue Report The import `pandas` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
14			from functools import wraps
15
16			from .. import core
17
18			def takes_mol_series(func):
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 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...
19			@wraps(func)
20			@takes_pandas
21			def inner(inp, args, *kwargs):
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 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...
22			if isinstance(inp, pd.DataFrame):
23			inp = inp.structure
24			return func(inp, args, *kwargs)
25			return inner
26
27			def method_takes_mol_series(func):
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 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...
28			@wraps(func)
29			def inner(self, args, *kwargs):
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 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...
30			return takes_mol_series(lambda args, kwargs: func(self, args, *kwargs))(args, **kwargs)
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (101/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history... Coding Style introduced 2016-06-30 13:44 UTC by Report Bug Copy Issue Report Usage of `` or `` arguments should usually be done with care. Generally, there is nothing wrong with usage of `` or `**` arguments. For readability of the code base, we suggest to not over-use these language constructs though. For more information, we can recommend this blog post from Ned Batchelder including its comments which also touches this aspect. Loading history...
31			return inner
32
33			def takes_pandas(func):
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 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...
34			@wraps(func)
35			def inner(inp, args, *kwargs):
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 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...
36			single = False
37			if isinstance(inp, core.Mol):
38			single = True
39			inp = pd.Series({inp.name: inp})
40			elif isinstance(inp, (list, tuple)):
41			inp = pd.Series(inp, index=[mol.name for mol in inp])
42			elif isinstance(inp, dict):
43			inp = pd.Series(inp)
44			elif isinstance(inp, (pd.Series, pd.DataFrame)):
45			pass
46			else:
47			raise NotImplementedError('{} cannot take object of type: {}'.format(func.__name__, type(inp)))
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (107/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
48			res = func(inp, args, *kwargs)
49			if single:
50			return res.iloc[0]
51			else:
52			return res
53			return inner
54
55			def method_takes_pandas(func):
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 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...
56			@wraps(func)
57			def inner(self, args, *kwargs):
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 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...
58			return takes_pandas(lambda args, kwargs: func(self, args, *kwargs))(args, **kwargs)
			0 ignored issues – show Coding Style introduced 2016-06-30 13:44 UTC by Report Bug Copy Issue Report Usage of `` or `` arguments should usually be done with care. Generally, there is nothing wrong with usage of `` or `**` arguments. For readability of the code base, we suggest to not over-use these language constructs though. For more information, we can recommend this blog post from Ned Batchelder including its comments which also touches this aspect. Loading history...
59			return inner
60

richlewis42 / scikit-chem

Push — master ( 97f98d...9ca1ad )

method_takes_pandas() A

Complexity

Size

Duplication

Importance

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files