Fix PEP8 issues

Author: gdubicki

Diff for: pypuppetdb/QueryBuilder.py

@@ -288,9 +288,9 @@ def add_array(self, values):
         if self.query is not None:
             raise APIError("Only one array is supported by the InOperator")
         elif isinstance(values, list):
-            def depth(l):
-                return (isinstance(l, list) and len(l) != 0) \
-                       and max(map(depth, l)) + 1
+            def depth(a_list):
+                return (isinstance(a_list, list) and len(a_list) != 0) \
+                       and max(map(depth, a_list)) + 1
 
             if depth(values) == 1:
                 self.query = True
@@ -358,8 +358,8 @@ def add_query(self, query):
                            "Operator Objects")
 
     def add_order_by(self, fields):
-        def depth(l):
-            return isinstance(l, list) and max(map(depth, l)) + 1
+        def depth(a_list):
+            return isinstance(a_list, list) and max(map(depth, a_list)) + 1
 
         fields_depth = depth(fields)
 

Diff for: pypuppetdb/api/base.py

@@ -325,7 +325,7 @@ def _query(self, endpoint=None, path=None, query=None,
         :rtype: :obj:`dict` or :obj:`list`
         """
 
-        log.debug(f"_query called with ",
+        log.debug("_query called with ",
                   # comma-separated list of method arguments with their values
                   ", ".join([f"{arg}: {locals().get(arg, 'None')}"
                              for arg in locals().keys() if arg != 'self'])

Diff for: pypuppetdb/api/pql.py

@@ -9,7 +9,7 @@
 from pypuppetdb.QueryBuilder import (EqualsOperator)
 from pypuppetdb.api.base import BaseAPI
 from pypuppetdb.errors import (APIError)
-from pypuppetdb.types import (Catalog, Node, Report)
+from pypuppetdb.types import (Node, Report)
 
 log = logging.getLogger(__name__)
 
@@ -151,5 +151,5 @@ def _get_type_from_query(pql):
                           f" but it is not supported by this library yet.")
                 return None
         else:
-            log.debug(f"No match!")
+            log.debug("No match!")
             return None

Diff for: pypuppetdb/api/query.py

@@ -4,7 +4,6 @@
 import logging
 from datetime import datetime
 
-import pypuppetdb
 from pypuppetdb.QueryBuilder import (EqualsOperator)
 from pypuppetdb.api.base import BaseAPI
 from pypuppetdb.types import (Catalog, Edge, Event, Fact, Inventory,
@@ -39,7 +38,7 @@ def nodes(self, unreported=2, with_status=False, with_event_numbers=True,
                            This provides performance benefits as potentially
                            slow event-counts query is omitted completely.
         :type with_event_numbers: :bool:
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function
 
         :returns: A generator yieling Nodes.
@@ -81,7 +80,7 @@ def node(self, name):
     def edges(self, **kwargs):
         """Get the known catalog edges, formed between two resources.
 
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function.
 
         :returns: A generating yielding Edges.
@@ -95,7 +94,7 @@ def edges(self, **kwargs):
     def environments(self, **kwargs):
         """Get all known environments from Puppetdb.
 
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function.
 
         :returns: A list of dictionaries containing the results.
@@ -112,7 +111,7 @@ def facts(self, name=None, value=None, **kwargs):
             match this value. Use of this parameter requires the `name`\
             parameter be set.
         :type value: :obj:`string`
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
             to the _query function
 
         :returns: A generator yielding Facts.
@@ -132,7 +131,7 @@ def facts(self, name=None, value=None, **kwargs):
     def factsets(self, **kwargs):
         """Returns a set of all facts or for a single certname.
 
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function.
 
         :returns: A list of dictionaries containg the results.
@@ -145,7 +144,7 @@ def fact_contents(self, **kwargs):
         to descend into structured facts and retreive the values associated
         with fact paths.
 
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function.
 
         :returns: A list of dictionaries containg the results.
@@ -159,7 +158,7 @@ def fact_paths(self, **kwargs):
         facts and may be used for building GUI autocompletions or other
         applications that require a basic top-level view of fact paths.
 
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function.
 
         :returns: A list of dictionaries containg the results.
@@ -179,7 +178,7 @@ def resources(self, type_=None, title=None, **kwargs):
             'namevar' in the Puppet Manifests. This parameter requires the\
             `type_` parameter be set.
         :type title: :obj:`string`
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
             to the _query function
 
         :returns: A generator yielding Resources
@@ -218,7 +217,7 @@ def catalogs(self, **kwargs):
         and/or paging parameters for this endpoint to prevent large result
         sets or PuppetDB performance bottlenecks.
 
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function.
 
         :returns: A generator yielding Catalogs
@@ -240,7 +239,7 @@ def events(self, **kwargs):
         endpoint to prevent large result sets or PuppetDB performance
         bottlenecks.
 
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function
 
         :returns: A generator yielding Events
@@ -268,7 +267,7 @@ def event_counts(self, summarize_by, **kwargs):
                              `<`, `>=`, and `<=`. Supported fields are
                              `failures`, `successes`, `noops`, and `skips`.
         :type count_filter: :obj:`string`
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function.
 
         :returns: A list of dictionaries containing the results.
@@ -319,7 +318,7 @@ def reports(self, **kwargs):
         prevent large result sets and potential PuppetDB performance
         bottlenecks.
 
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function
 
         :returns: A generating yielding Reports
@@ -334,7 +333,7 @@ def inventory(self, **kwargs):
         for structured facts instead of using the facts, fact-contents and
         factsets endpoints for many fact-related queries.
 
-        :param \*\*kwargs: The rest of the keyword arguments are passed
+        :param **kwargs: The rest of the keyword arguments are passed
                            to the _query function.
 
         :returns: A generator yielding Inventory

Diff for: pypuppetdb/types.py

@@ -4,7 +4,7 @@
 import logging
 from datetime import timedelta
 
-from pypuppetdb.QueryBuilder import (EqualsOperator)
+from pypuppetdb.QueryBuilder import (EqualsOperator, AndOperator)
 from pypuppetdb.utils import json_to_datetime
 
 log = logging.getLogger(__name__)
@@ -20,22 +20,22 @@ class Event(object):
     :type status: :obj:`string`
     :param timestamp: A timestamp of when this event occured.
     :type timestamp: :obj:`string` formatted as ``%Y-%m-%dT%H:%M:%S.%fZ``
-    :param hash\_: The hash of the report that contains this event.
-    :type hash\_: :obj:`string`
+    :param hash_: The hash of the report that contains this event.
+    :type hash_: :obj:`string`
     :param title: The resource title this event was fired for.
     :type title: :obj:`string`
-    :param property\_: The property of the resource this event was fired for.
-    :type property\_: :obj:`string`
+    :param property_: The property of the resource this event was fired for.
+    :type property_: :obj:`string`
     :param message: A message associated with this event.
     :type message: :obj:`string`
     :param new_value: The new value/state of the resource.
     :type new_value: :obj:`string`
     :param old_value: The old value/state of the resource.
     :type old_value: :obj:`string`
-    :param type\_: The type of the resource this event fired for.
-    :type type\_: :obj:`string`
-    :param class\_: The class responsible for running this event.
-    :type class\_: :obj:`string`
+    :param type_: The type of the resource this event fired for.
+    :type type_: :obj:`string`
+    :param class_: The class responsible for running this event.
+    :type class_: :obj:`string`
     :param execution_path: The path used to reach this particular resource.
     :type execution_path: :obj:`string`
     :param source_file: The puppet source code file containing the class.
@@ -50,7 +50,7 @@ class Event(object):
     :ivar timestamp: A :obj:`datetime.datetime` of when this event happend.
     :ivar node: The hostname of the machine this event\
         occured on.
-    :ivar hash\_: The hash of this event.
+    :ivar hash_: The hash of this event.
     :ivar item: :obj:`dict` with information about the item/resource this\
         event was triggered for.
     """
@@ -109,8 +109,8 @@ class Report(object):
     :type api: :class:`pypuppetdb.api.BaseAPI`
     :param node: The hostname of the node this report originated on.
     :type node: :obj:`string`
-    :param hash\_: A string uniquely identifying this report.
-    :type hash\_: :obj:`string`
+    :param hash_: A string uniquely identifying this report.
+    :type hash_: :obj:`string`
     :param start: The start time of the agent run.
     :type start: :obj:`string` formatted as ``%Y-%m-%dT%H:%M:%S.%fZ``
     :param end: The time the agent finished its run.
@@ -119,8 +119,8 @@ class Report(object):
     :type received: :obj:`string` formatted as ``%Y-%m-%dT%H:%M:%S.%fZ``
     :param version: The catalog / configuration version.
     :type version: :obj:`string`
-    :param format\_: The catalog format version.
-    :type format\_: :obj:`int`
+    :param format_: The catalog format version.
+    :type format_: :obj:`int`
     :param agent_version: The Puppet agent version.
     :type agent_version: :obj:`string`
     :param transaction: The UUID of this transaction.
@@ -156,13 +156,12 @@ class Report(object):
     :type producer: :obj:`string`
 
     :ivar node: The hostname this report originated from.
-    :ivar hash\_: Unique identifier of this report.
+    :ivar hash_: Unique identifier of this report.
     :ivar start: :obj:`datetime.datetime` when the Puppet agent run started.
     :ivar end: :obj:`datetime.datetime` when the Puppet agent run ended.
-    :ivar received: :obj:`datetime.datetime` when the report finished\
-        uploading.
+    :ivar received: :obj:`datetime.datetime` when the report finished uploading.
     :ivar version: :obj:`string` catalog configuration version.
-    :ivar format\_: :obj:`int` catalog format version.
+    :ivar format_: :obj:`int` catalog format version.
     :ivar agent_version: :obj:`string` Puppet Agent version.
     :ivar run_time: :obj:`datetime.timedelta` of **end** - **start**.
     :ivar transaction: UUID identifying this transaction.
@@ -299,11 +298,11 @@ class Resource(object):
     parameters are required.
 
     :param node: The hostname this resource is located on.
-    :type noode: :obj:`string`
+    :type node: :obj:`string`
     :param name: The name of the resource in the Puppet manifest.
     :type name: :obj:`string`
-    :param type\_: Type of the Puppet resource.
-    :type type\_: :obj:`string`
+    :param type_: Type of the Puppet resource.
+    :type type_: :obj:`string`
     :param tags: Tags associated with this resource.
     :type tags: :obj:`list`
     :param exported: If it's an exported resource.
@@ -321,7 +320,7 @@ class Resource(object):
 
     :ivar node: The hostname this resources is located on.
     :ivar name: The name of the resource in the Puppet manifest.
-    :ivar type\_: The type of Puppet resource.
+    :ivar type_: The type of Puppet resource.
     :ivar exported: :obj:`bool` if the resource is exported.
     :ivar sourcefile: The Puppet manifest this resource is declared in.
     :ivar sourceline: The line this resource is declared at.
@@ -420,7 +419,7 @@ class Node(object):
     :param cached_catalog_status: Cached catalog status of the last puppet run\
             on this node, possible values are 'explicitly_requested',\
             'on_failure', 'not_used' or None.
-    :type cache_catalog_status: :obj:`string`
+    :type cached_catalog_status: :obj:`string`
 
     :ivar name: Hostname of this node.
     :ivar deactivated: :obj:`datetime.datetime` when this host was\

Diff for: tests/test_api_base_init.py

@@ -44,7 +44,7 @@ def test_defaults(self, api):
         assert api.protocol == 'http'
         assert api.url_path == ''
         assert api.session.auth is None
-        assert api.metric_api_version is 'v2'
+        assert api.metric_api_version == 'v2'
 
     def test_host(self):
         api = pypuppetdb.api.API(host='127.0.0.1')
@@ -102,7 +102,7 @@ def test_override_protocol(self):
 
     def test_invalid_protocol(self):
         with pytest.raises(ValueError):
-            api = pypuppetdb.api.API(protocol='ftp')
+            pypuppetdb.api.API(protocol='ftp')
 
     def test_url_path(self):
         api = pypuppetdb.api.API(url_path='puppetdb')

Diff for: tests/test_querybuilder.py

@@ -515,7 +515,7 @@ def test_init_from(self):
             str(fr) == "unimportant_no_query"
 
         with pytest.raises(APIError):
-            fr2 = FromOperator('invalid_entity')
+            FromOperator('invalid_entity')
 
     def test_add_query(self):
         fr = FromOperator("facts")

Diff for: tests/test_types.py

@@ -42,7 +42,7 @@ def test_with_status_unreported(self):
         assert node.catalog_timestamp == \
             json_to_datetime('2013-08-01T09:57:00.000Z')
         assert node.status == 'unreported'
-        assert node.unreported_time is '0d 5h 20m'
+        assert node.unreported_time == '0d 5h 20m'
         assert str(node) == str('node')
         assert str(node) == str('node')
         assert repr(node) == str('<Node: node>')
@@ -66,7 +66,7 @@ def test_with_status_unreported_from_noop(self):
         assert node.catalog_timestamp == \
             json_to_datetime('2013-08-01T09:57:00.000Z')
         assert node.status == 'unreported'
-        assert node.unreported_time is '0d 5h 20m'
+        assert node.unreported_time == '0d 5h 20m'
         assert str(node) == str('node')
         assert str(node) == str('node')
         assert repr(node) == str('<Node: node>')
@@ -90,7 +90,7 @@ def test_with_status_unreported_from_failed(self):
         assert node.catalog_timestamp == \
             json_to_datetime('2013-08-01T09:57:00.000Z')
         assert node.status == 'unreported'
-        assert node.unreported_time is '0d 5h 20m'
+        assert node.unreported_time == '0d 5h 20m'
         assert str(node) == str('node')
         assert str(node) == str('node')
         assert repr(node) == str('<Node: node>')