_unwrap_target_assoc_proxy() - Code Metrics - Inspection of "Monkey patch SQLAlchemy to support queries on chai..." - Natureshadow/OSMAlchemy - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 854889...991fbf )

by Dominik

created 2016-08-12 11:33 UTC

_unwrap_target_assoc_proxy() A

↳ Parent: monkey_patch_sqlalchemy()

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	4.048

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
c	1
b	0
f	0
dl	0
loc	5
ccs	1
cts	5
cp	0.2
crap	4.048
rs	9.4285

# ~*~ coding: utf-8 ~*~
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
#-
# OSMAlchemy - OpenStreetMap to SQLAlchemy bridge
# Copyright (c) 2016 Michael Bayer (zzzeek)
# Copyright (c) 2016 Dominik George <[email protected]>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

def monkey_patch_sqlalchemy():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    from sqlalchemy.ext.associationproxy import AssociationProxy
    from sqlalchemy.util import memoized_property

    # Monkey patch support for chained association proxy queries into SQLAlchemy
    # https://bitbucket.org/zzzeek/sqlalchemy/issues/3769/chained-any-has-with-association-proxy
    if not hasattr(AssociationProxy, "_unwrap_target_assoc_proxy"):
        def _unwrap_target_assoc_proxy(self):
            attr = getattr(self.target_class, self.value_attr)
            if isinstance(attr, AssociationProxy):
                return attr, getattr(self.target_class, attr.target_collection)
            return None, None
        AssociationProxy._unwrap_target_assoc_proxy = memoized_property(_unwrap_target_assoc_proxy)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent

        orig_any = AssociationProxy.any
        def any(self, criterion=None, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            target_assoc, inner = self._unwrap_target_assoc_proxy
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
            if target_assoc is not None:
                if target_assoc._target_is_object and target_assoc._uselist:
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
                    inner = inner.any(criterion=criterion, **kwargs)
                else:
                    inner = inner.has(criterion=criterion, **kwargs)
                return self._comparator.any(inner)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
            orig_any(self, criterion, **kwargs)
        AssociationProxy.any = any

        orig_has = AssociationProxy.has
        def has(self, criterion=None, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            target_assoc, inner = self._unwrap_target_assoc_proxy
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
            if target_assoc is not None:
                if target_assoc._target_is_object and target_assoc._uselist:
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
                    inner = inner.any(criterion=criterion, **kwargs)
                else:
                    inner = inner.has(criterion=criterion, **kwargs)
                return self._comparator.has(inner)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
            orig_has(self, criterion, **kwargs)
        AssociationProxy.has = has


1		# ~~ coding: utf-8 ~~
		0 ignored issues – show Coding Style introduced 2016-08-12 11:47 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		# OSMAlchemy - OpenStreetMap to SQLAlchemy bridge
4		# Copyright (c) 2016 Michael Bayer (zzzeek)
5		# Copyright (c) 2016 Dominik George <[email protected]>
6		#
7		# Permission is hereby granted, free of charge, to any person obtaining a copy
8		# of this software and associated documentation files (the "Software"), to deal
9		# in the Software without restriction, including without limitation the rights
10		# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11		# copies of the Software, and to permit persons to whom the Software is
12		# furnished to do so, subject to the following conditions:
13		#
14		# The above copyright notice and this permission notice shall be included in all
15		# copies or substantial portions of the Software.
16		#
17		# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18		# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19		# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20		# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21		# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22		# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23		# SOFTWARE.
24
25	1	def monkey_patch_sqlalchemy():
		0 ignored issues – show Coding Style introduced 2016-08-12 11:47 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...
26	1	from sqlalchemy.ext.associationproxy import AssociationProxy
27	1	from sqlalchemy.util import memoized_property
28
29		# Monkey patch support for chained association proxy queries into SQLAlchemy
30		# https://bitbucket.org/zzzeek/sqlalchemy/issues/3769/chained-any-has-with-association-proxy
31	1	if not hasattr(AssociationProxy, "_unwrap_target_assoc_proxy"):
32	1	def _unwrap_target_assoc_proxy(self):
33		attr = getattr(self.target_class, self.value_attr)
34		if isinstance(attr, AssociationProxy):
35		return attr, getattr(self.target_class, attr.target_collection)
36		return None, None
37	1	AssociationProxy._unwrap_target_assoc_proxy = memoized_property(_unwrap_target_assoc_proxy)
		0 ignored issues – show Coding Style Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report It seems like `_unwrap_target_assoc_proxy` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
38
39	1	orig_any = AssociationProxy.any
40	1	def any(self, criterion=None, **kwargs):
		0 ignored issues – show Bug Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `any`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history... Coding Style introduced 2016-08-12 11:47 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...
41		target_assoc, inner = self._unwrap_target_assoc_proxy
		0 ignored issues – show Coding Style Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report It seems like `_unwrap_target_assoc_proxy` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
42		if target_assoc is not None:
43		if target_assoc._target_is_object and target_assoc._uselist:
		0 ignored issues – show Coding Style Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report It seems like `_target_is_object` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history... Coding Style Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report It seems like `_uselist` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
44		inner = inner.any(criterion=criterion, **kwargs)
45		else:
46		inner = inner.has(criterion=criterion, **kwargs)
47		return self._comparator.any(inner)
		0 ignored issues – show Coding Style Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report It seems like `_comparator` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
48		orig_any(self, criterion, **kwargs)
49	1	AssociationProxy.any = any
50
51	1	orig_has = AssociationProxy.has
52	1	def has(self, criterion=None, **kwargs):
		0 ignored issues – show Coding Style introduced 2016-08-12 11:47 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...
53		target_assoc, inner = self._unwrap_target_assoc_proxy
		0 ignored issues – show Coding Style Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report It seems like `_unwrap_target_assoc_proxy` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
54		if target_assoc is not None:
55		if target_assoc._target_is_object and target_assoc._uselist:
		0 ignored issues – show Coding Style Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report It seems like `_target_is_object` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history... Coding Style Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report It seems like `_uselist` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
56		inner = inner.any(criterion=criterion, **kwargs)
57		else:
58		inner = inner.has(criterion=criterion, **kwargs)
59		return self._comparator.has(inner)
		0 ignored issues – show Coding Style Best Practice introduced 2016-08-12 11:47 UTC by Report Bug Copy Issue Report It seems like `_comparator` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
60		orig_has(self, criterion, **kwargs)
61		AssociationProxy.has = has
62

Natureshadow / OSMAlchemy

Push — master ( 854889...991fbf )

_unwrap_target_assoc_proxy() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like