Monty Taylor
fb8f5a44bd
python3 includes support for optional type annotations which can be used by static analysis tools to perform type checking. The mypy tool is a static type checking tool that can also infer type information in many cases, but which will use explicit type information if it is present. Add mypy to test-requirements and to the pep8 job so that our pep8 job can do more analysis work and less with the code style. To support this, there were a few places in the current codebase that needed an explicit type hint. For variables/attributes in 3.5 this is done via comments. There is a conditional import that was confusion that just got marked with an 'ignore'. Our ansible action and lookup plugins confuse mypi with the way they import the ansible base classes. That's ok - they confuse us with that too. The .pyi files are 'typeshed' files, which are a way that one can provide static type annotations without putting the information into the file itself. mypy will always prefer a .pyi file over a .py file (since the point of them is to be external annotion/interface description) So in order to get mypy to not barf on the ansible import weirdness, just add a corresponding empty .pyi file. We could potentially actually put interface descriptions in them - but I don't think there is very much value in that. It should be amusing to at least someone that we have to flake8: noqa an import from typing that was done to provide a type hint in a comment. Change-Id: I6c4ac3dcfc6fd990e6c6886749de147ad28389d1
34 lines
1.1 KiB
Python
34 lines
1.1 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
import yaml
|
|
from yaml import YAMLObject, YAMLError # noqa: F401
|
|
|
|
try:
|
|
# Explicit type ignore to deal with provisional import failure
|
|
from yaml import cyaml # type: ignore
|
|
import _yaml
|
|
SafeLoader = cyaml.CSafeLoader
|
|
SafeDumper = cyaml.CSafeDumper
|
|
Mark = _yaml.Mark
|
|
except ImportError:
|
|
SafeLoader = yaml.SafeLoader
|
|
SafeDumper = yaml.SafeDumper
|
|
Mark = yaml.Mark
|
|
|
|
|
|
def safe_load(stream, *args, **kwargs):
|
|
return yaml.load(stream, *args, Loader=SafeLoader, **kwargs)
|
|
|
|
|
|
def safe_dump(stream, *args, **kwargs):
|
|
return yaml.dump(stream, *args, Dumper=SafeDumper, **kwargs)
|