Merge pull request #213 from gdubicki/add_python_3.10

Add Python 3.10 support

Author: bastelfreak

.coveragerc

@@ -1,3 +1,14 @@
 [report]
 exclude_lines =
     pragma: notest
+
+[run]
+source =
+    pypuppetdb
+
+omit =
+    # don't check the test themselves, obviously
+    tests/*
+
+    # no point in checking this
+    setup.py

.github/workflows/publish-to-pypi.yml

@@ -12,10 +12,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
       - name: Install dependencies
         run: |
           pip install wheel

.github/workflows/security.yml

@@ -9,10 +9,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
       - name: Install dependencies
         run: |
           pip install bandit

.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       max-parallel: 5
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.6, 3.7, 3.8, 3.9, 3.10-dev]
 
     steps:
       - uses: actions/checkout@v2
@@ -20,12 +20,13 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
+          pip install --upgrade wheel setuptools
           pip install -r requirements-test.txt
+          mypy --install-types --non-interactive pypuppetdb/ tests/
       - name: Test
         run: |
-          pytest --pep8 --strict-markers --mypy pypuppetdb tests
-      - name: Run coveralls
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          coveralls --service=github
+          pytest --cov=. --cov-report=xml --flake8 --strict-markers --mypy pypuppetdb tests
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          fail_ci_if_error: true

.gitignore

@@ -27,6 +27,7 @@ pip-log.txt
 
 # Unit test / coverage reports
 .coverage
+coverage.xml
 .tox
 nosetests.xml
 htmlcov
@@ -48,3 +49,6 @@ docs/_build
 
 # OS X
 .DS_*
+
+# private test data
+private/

.readthedocs.yaml

@@ -6,7 +6,7 @@ sphinx:
   fail_on_warning: true
 
 python:
-  version: 3.8
+  version: 3.9
   install:
     - requirements: docs/requirements.txt
     - method: setuptools

CONTRIBUTING.md

@@ -28,6 +28,8 @@ Pope](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 # Create a Python 3 virtualenv and activate it
 virtualenv -p python3 .venv
 . .venv/bin/activate
+# Get the up to date base packages
+pip install --upgrade wheel setuptools
 # Install the module in a development mode
 python setup.py develop
 # Install test dependencies
@@ -44,7 +46,8 @@ do this to run the tests:
 
 ```bash
 # Unit tests, with PEP8 and mypy (static typing) checks
-pytest --pep8 --strict-markers --mypy pypuppetdb tests
+mypy --install-types --non-interactive pypuppetdb/ tests/
+pytest --flake8 --strict-markers --mypy pypuppetdb tests
 # Security linter
 bandit -r pypuppetdb
 ```

README.md

@@ -4,7 +4,7 @@
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pypuppetdb)](https://pypi.org/project/pypuppetdb/)
 [![PyPi Downloads](https://img.shields.io/pypi/dm/pypuppetdb)](https://pypi.org/project/pypuppetdb/)
 ![Tests Status](https://github.com/voxpupuli/pypuppetdb/workflows/tests%20(unit)/badge.svg)
-[![Coverage Status](https://img.shields.io/coveralls/voxpupuli/pypuppetdb.svg)](https://coveralls.io/r/voxpupuli/pypuppetdb)
+[![codecov](https://codecov.io/gh/voxpupuli/pypuppetdb/branch/master/graph/badge.svg?token=mOOj805A15)](https://codecov.io/gh/voxpupuli/pypuppetdb)
 [![Documentation Status](https://readthedocs.org/projects/pypuppetdb/badge/?version=latest)](https://pypuppetdb.readthedocs.io/en/latest/?badge=latest)
 [![By Voxpupuli](https://img.shields.io/badge/by-Vox%20Pupuli%20%F0%9F%A6%8A-ef902f.svg)](https://voxpupuli.org)
 
@@ -16,7 +16,7 @@ PuppetDB.
 
 * PuppetDB 3.0 or newer
   * (For support of older PuppetDB versions please check versions < 0.2.0)
-* Python 3.6 / 3.7 / 3.8 / 3.9
+* Python 3.6 / 3.7 / 3.8 / 3.9 / 3.10
 
 ## Installation
 

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)
 

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'])

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

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