diff --git a/sdk/python/.pylintrc b/sdk/python/.pylintrc new file mode 100644 index 000000000..306d8ad18 --- /dev/null +++ b/sdk/python/.pylintrc @@ -0,0 +1,572 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns=.*_pb2.* + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=0 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=print-statement, + parameter-unpacking, + unpacking-in-except, + old-raise-syntax, + backtick, + long-suffix, + old-ne-operator, + old-octal-literal, + import-star-module-level, + non-ascii-bytes-literal, + raw-checker-failed, + bad-inline-option, + locally-disabled, + locally-enabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + apply-builtin, + basestring-builtin, + buffer-builtin, + cmp-builtin, + coerce-builtin, + execfile-builtin, + file-builtin, + long-builtin, + raw_input-builtin, + reduce-builtin, + standarderror-builtin, + unicode-builtin, + xrange-builtin, + coerce-method, + delslice-method, + getslice-method, + setslice-method, + no-absolute-import, + old-division, + dict-iter-method, + dict-view-method, + next-method-called, + metaclass-assignment, + indexing-exception, + raising-string, + reload-builtin, + oct-method, + hex-method, + nonzero-method, + cmp-method, + input-builtin, + round-builtin, + intern-builtin, + unichr-builtin, + map-builtin-not-iterating, + zip-builtin-not-iterating, + range-builtin-not-iterating, + filter-builtin-not-iterating, + using-cmp-argument, + eq-without-hash, + div-method, + idiv-method, + rdiv-method, + exception-message-attribute, + invalid-str-codec, + sys-max-int, + bad-python3-import, + deprecated-string-function, + deprecated-str-translate-call, + deprecated-itertools-function, + deprecated-types-field, + next-method-defined, + dict-items-not-iterating, + dict-keys-not-iterating, + dict-values-not-iterating, + deprecated-operator-function, + deprecated-urllib-function, + xreadlines-attribute, + deprecated-sys-function, + exception-escape, + comprehension-escape, + + # Pulumi-specific exclusions begin here + too-few-public-methods, + wildcard-import, + global-statement, + invalid-name, + protected-access, + too-many-arguments, + missing-docstring, + fixme, + broad-except, + no-self-use, + unused-import + + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package.. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=200 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma, + dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=yes + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled). +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled). +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement. +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception". +overgeneral-exceptions=Exception diff --git a/sdk/python/Makefile b/sdk/python/Makefile index 34aba50da..584b53d82 100644 --- a/sdk/python/Makefile +++ b/sdk/python/Makefile @@ -47,7 +47,7 @@ build_plugin:: build:: build_package build_plugin lint:: - pipenv run pylint -E ./lib/pulumi --ignore-patterns '.*_pb2_.*.py' + pipenv run pylint ./lib/pulumi --rcfile=.pylintrc $(GOMETALINTER) ./cmd/pulumi-language-python/... | sort ; exit $${PIPESTATUS[0]} $(GOMETALINTER) ./pkg/... | sort ; exit $${PIPESTATUS[0]} diff --git a/sdk/python/lib/.pylintrc b/sdk/python/lib/.pylintrc deleted file mode 100644 index afb2eae04..000000000 --- a/sdk/python/lib/.pylintrc +++ /dev/null @@ -1,9 +0,0 @@ -[MASTER] -ignore=pulumi.runtime.proto - -[DESIGN] -max-args=10 -min-public-methods=0 - -[FORMAT] -max-line-length=120 diff --git a/sdk/python/lib/pulumi/asset.py b/sdk/python/lib/pulumi/asset.py index dfc512df4..340046204 100644 --- a/sdk/python/lib/pulumi/asset.py +++ b/sdk/python/lib/pulumi/asset.py @@ -15,7 +15,7 @@ """ Assets are the Pulumi notion of data blobs that can be passed to resources. """ -from typing import Dict, Union, Any +from typing import Dict, Union from .runtime import known_types diff --git a/sdk/python/lib/pulumi/config.py b/sdk/python/lib/pulumi/config.py index 577747a82..a5f4fa4c6 100644 --- a/sdk/python/lib/pulumi/config.py +++ b/sdk/python/lib/pulumi/config.py @@ -56,12 +56,11 @@ class Config: v = self.get(key) if v is None: return None - elif v in ['true', 'True']: + if v in ['true', 'True']: return True - elif v in ['false', 'False']: + if v in ['false', 'False']: return False - else: - raise ConfigTypeError(self.full_key(key), v, 'bool') + raise ConfigTypeError(self.full_key(key), v, 'bool') def get_int(self, key: str) -> Optional[int]: """ diff --git a/sdk/python/lib/pulumi/output.py b/sdk/python/lib/pulumi/output.py index 1787bb2a1..1ea2e52e3 100644 --- a/sdk/python/lib/pulumi/output.py +++ b/sdk/python/lib/pulumi/output.py @@ -166,7 +166,7 @@ class Output(Generic[T]): """ return self.apply(lambda v: getattr(v, item)) - + def __getitem__(self, key: Any) -> 'Output[Any]': """ Syntax sugar for looking up attributes dynamically off of outputs. diff --git a/sdk/python/lib/pulumi/resource.py b/sdk/python/lib/pulumi/resource.py index e79950077..43b0f9fed 100644 --- a/sdk/python/lib/pulumi/resource.py +++ b/sdk/python/lib/pulumi/resource.py @@ -46,10 +46,10 @@ class Resource: Resource represents a class whose CRUD operations are implemented by a provider plugin. """ + urn: 'Output[str]' """ The stable, logical URN used to distinctly address a resource, both before and after deployments. """ - urn: 'Output[str]' def __init__(self, t: str, @@ -96,22 +96,23 @@ class CustomResource(Resource): loaded plugin for the defining package. """ + id: 'Output[str]' """ id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases. """ - id: str - """ - CustomResource is a resource whose CRUD operations are managed by performing external operations on some - physical entity. Pulumi understands how to diff and perform partial updates ot them, and these CRUD operations - are implemented in a dynamically loaded plugin for the defining package. - """ + def __init__(self, t: str, name: str, props: Optional[dict] = None, opts: Optional[ResourceOptions] = None) -> None: + """ + CustomResource is a resource whose CRUD operations are managed by performing external operations on some + physical entity. Pulumi understands how to diff and perform partial updates ot them, and these CRUD operations + are implemented in a dynamically loaded plugin for the defining package. + """ Resource.__init__(self, t, name, True, props, opts) diff --git a/sdk/python/lib/pulumi/runtime/invoke.py b/sdk/python/lib/pulumi/runtime/invoke.py index f79518b98..08467354b 100644 --- a/sdk/python/lib/pulumi/runtime/invoke.py +++ b/sdk/python/lib/pulumi/runtime/invoke.py @@ -12,9 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. import asyncio -import grpc import sys from typing import Any +import grpc from ..output import Inputs from .. import log diff --git a/sdk/python/lib/pulumi/runtime/resource.py b/sdk/python/lib/pulumi/runtime/resource.py index d92655819..d8400943a 100644 --- a/sdk/python/lib/pulumi/runtime/resource.py +++ b/sdk/python/lib/pulumi/runtime/resource.py @@ -12,10 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. import asyncio -import grpc import sys -import traceback -from typing import Optional, Awaitable, Any, Callable, List, NamedTuple, Dict, Set, Union, TYPE_CHECKING +from typing import Optional, Any, Callable, List, NamedTuple, Dict, Set, TYPE_CHECKING +import grpc from . import rpc, settings, known_types from .. import log @@ -45,7 +44,7 @@ async def prepare_resource(res: 'Resource', ty: str, props: 'Inputs', opts: Opti # Serialize out all our props to their final values. In doing so, we'll also collect all # the Resources pointed to by any Dependency objects we encounter, adding them to 'implicit_dependencies'. implicit_dependencies: List[Resource] = [] - serialized_props = await rpc.serialize_properties(props, implicit_dependencies, lambda p: res.translate_input_property(p)) + serialized_props = await rpc.serialize_properties(props, implicit_dependencies, res.translate_input_property) # Wait for our parent to resolve parent_urn = "" @@ -70,6 +69,7 @@ async def prepare_resource(res: 'Resource', ty: str, props: 'Inputs', opts: Opti ) +# pylint: disable=too-many-locals def register_resource(res: 'Resource', ty: str, name: str, custom: bool, props: 'Inputs', opts: Optional['ResourceOptions']): """ registerResource registers a new resource object with a given type t and name. It returns the auto-generated @@ -147,6 +147,6 @@ def register_resource(res: 'Resource', ty: str, name: str, custom: bool, props: asyncio.ensure_future(RPC_MANAGER.do_rpc("register resource", do_register)()) -def register_resource_outputs(res: 'Resource', inputs: 'Union[Inputs, Awaitable[Inputs], Output[Inputs]]'): +def register_resource_outputs(_res: 'Resource', _inputs: 'Union[Inputs, Awaitable[Inputs], Output[Inputs]]'): # TODO(swgillespie) needed for stack outputs and component resources. pass diff --git a/sdk/python/lib/pulumi/runtime/rpc.py b/sdk/python/lib/pulumi/runtime/rpc.py index f8c5f760f..27fa6ac09 100644 --- a/sdk/python/lib/pulumi/runtime/rpc.py +++ b/sdk/python/lib/pulumi/runtime/rpc.py @@ -43,7 +43,7 @@ _special_archive_sig = "0def7320c3a5731c473e5ecbe6d01bc7" async def serialize_properties(inputs: 'Inputs', deps: List['Resource'], - transform: Optional[Callable[[str], str]]=None) -> struct_pb2.Struct: + transform: Optional[Callable[[str], str]] = None) -> struct_pb2.Struct: """ Serializes an arbitrary Input bag into a Protobuf structure, keeping track of the list of dependent resources in the `deps` list. Serializing properties is inherently async @@ -57,6 +57,7 @@ async def serialize_properties(inputs: 'Inputs', return struct +# pylint: disable=too-many-return-statements, too-many-branches async def serialize_property(value: 'Input[Any]', deps: List['Resource'], transform: Optional[Callable[[str], str]] = None) -> Any: @@ -137,7 +138,7 @@ async def serialize_property(value: 'Input[Any]', return value - +# pylint: disable=too-many-return-statements def deserialize_properties(props_struct: struct_pb2.Struct) -> Any: """ Deserializes a protobuf `struct_pb2.Struct` into a Python dictionary containing normal @@ -307,4 +308,3 @@ async def resolve_outputs(res: 'Resource', props: 'Inputs', outputs: struct_pb2. for key, resolve in resolvers.items(): if key not in all_properties: resolve(None, not settings.is_dry_run()) -